计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

添加CloudTable转储任务

功能介绍

本接口用于添加CloudTable转储任务。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

stream_name

String

已创建的通道名称。

最大长度:60

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

destination_type

String

转储任务类型。

  • OBS:转储到OBS

  • MRS:转储到MRS

  • DLI:转储到DLI

  • CLOUDTABLE:转储到CloudTable

  • DWS:转储到DWS

缺省值:NOWHERE

枚举值:

  • CLOUDTABLE

cloudtable_destination_descriptor

CloudtableDestinationDescriptorRequest object

转储目的地为CloudTable的参数列表。

表4 CloudtableDestinationDescriptorRequest

参数

是否必选

参数类型

描述

task_name

String

转储任务的名称。 任务名称由英文字母、数字、中划线和下划线组成。长度为1~64个字符。

agency_name

String

在统一身份认证服务(IAM)中创建委托的名称,DIS需要获取IAM委托信息去访问您指定的资源。创建委托的参数设置如下:- 委托类型:云服务- 云服务:DIS- 持续时间:永久- “所属区域”为“全局服务”,“项目”为“对象存储服务”对应的“策略”包含“Tenant Administrator”。如果已经创建过委托,可以使用IAM服务提供的查询委托列表接口,获取有效可用的委托名称。取值范围:长度不超过64位,且不可配置为空。如果有在Console控制台使用转储任务,会提示自动创建委托,自动创建的委托名称为:dis_admin_agency

最大长度:64

deliver_time_interval

Integer

根据用户配置的时间,周期性的将数据导入OBS,若某个时间段内无数据,则此时间段不会生成打包文件。

单位:秒

最小值:30

最大值:900

缺省值:300

consumer_strategy

String

偏移量。

  • LATEST:最大偏移量,即获取最新的数据。

  • TRIM_HORIZON:最小偏移量,即读取最早的数据。

缺省值:LATEST

枚举值:

  • LATEST

  • TRIM_HORIZON

cloudtable_cluster_name

String

存储该通道数据的CloudTable集群名称。

如果选择转储OpenTSDB,则集群必须开启OpenTSDB。

cloudtable_cluster_id

String

存储该通道数据的CloudTable集群ID。

如果选择转储OpenTSDB,则集群必须开启OpenTSDB。

cloudtable_table_name

String

转储HBase时必选,表示存储该通道数据的CloudTable集群HBase表名称。

cloudtable_schema

CloudtableSchema object

转储HBase时必选,与“opentsdb_schema”二选一,表示CloudTable集群HBase数据的Schema配置。用于将通道内的JSON数据进行格式转换并导入Cloudtable的HBase表中。

opentsdb_schema

Array of OpenTSDBSchema objects

转储OpenTSDB时必选,与“cloudtable_schema”二选一,表示CloudTable集群OpenTSDB数据的Schema配置。用于将通道内的JSON数据进行格式转换并导入Cloudtable的OpenTSDB。

cloudtable_row_key_delimiter

String

转储HBase的rowkey分隔符,用于分隔生成rowKey的用户数据。取值范围:”, ”、 ”. ”、 ”|”、 ”; ”、 ”\”、 ”-”、 ”_”、 ”~”缺省值:”.”

obs_backup_bucket_path

String

用户数据转储CloudTable服务失败时,可选择将转储失败的数据备份至OBS服务,此参数为OBS服务的桶名称。

backup_file_prefix

String

用户数据转储CloudTable服务失败时,可选择将转储失败的数据备份至OBS服务,此参数为OBS桶下的自定义目录,多级目录可用“/”进行分隔,不可以“/”开头。取值范围:英文字母、数字和下划线。最大长度:最大长度为50个字符。默认配置为空。

retry_duration

String

用户数据导入CloudTable服务失败的失效重试时间。超出此时效,转储CloudTable失败的数据将备份至“OBS桶/ backup_file_prefix /cloudtable_error”或“OBS桶/ backup_file_prefix /opentsdb_error”目录下。取值范围: 0~7200。单位:秒。默认配置为1800。

表5 CloudtableSchema

参数

是否必选

参数类型

描述

row_key

Array of RowKey objects

CloudTable集群HBase数据rowkey的Schema配置,用于将通道内的JSON数据生成HBase数据的rowkey。

取值范围:1~64。

columns

Array of Column objects

CloudTable集群HBase数据列的Schema配置,用于将通道内的JSON数据生成HBase数据的列。

取值范围:1~4096。

表6 RowKey

参数

是否必选

参数类型

描述

value

String

通道内JSON数据的JSON属性名,用于生成HBase数据的rowkey。

type

String

通道内JSON数据的JSON属性的类型名称。

枚举值:

  • Bigint

  • Double

  • Boolean

  • Timestamp

  • String

  • Decimal

表7 Column

参数

是否必选

参数类型

描述

column_family_name

String

存储该通道数据的HBase表数据的列族名称。

column_name

String

存储该通道数据的HBase表数据的列名称。

取值范围:1~32,只能包含英文字母、数字和下划线。

value

String

通道内JSON数据的JSON属性名,用于生成HBase数据的列值。

type

String

通道内JSON数据的JSON属性的类型名称。

枚举值:

  • Bigint

  • Double

  • Boolean

  • Timestamp

  • String

  • Decimal

表8 OpenTSDBSchema

参数

是否必选

参数类型

描述

metric

Array of OpenTSDBMetric objects

CloudTable集群OpenTSDB数据metric的Schema配置,用于将通道内的JSON数据进行格式转换生成OpenTSDB数据的metric。

timestamp

OpenTSDBTimestamp object

CloudTable集群OpenTSDB 数据timestamp的Schema配置,用于将通道内的JSON数据进行格式转换生成OpenTSDB数据的timestamp。

value

OpenTSDBValue object

CloudTable集群OpenTSDB 数据value的Schema配置,用于将通道内的JSON数据进行格式转换生成OpenTSDB 数据的value。

tags

Array of OpenTSDBTags objects

CloudTable集群OpenTSDB数据tags的Schema配置,用于将通道内的JSON数据进行格式转换生成OpenTSDB数据的tags。

表9 OpenTSDBMetric

参数

是否必选

参数类型

描述

type

String

  • Constant表示metric为常量value的值。

  • String表示metric为通道内用户数据对应JSON属性的取值,且该JOSN属性的取值为String。

枚举值:

  • Constant

  • String

value

String

常量或通道内用户数据的JSON属性名称。

取值范围:1~32,只能包含英文字母、数字和点。

表10 OpenTSDBTimestamp

参数

是否必选

参数类型

描述

type

String

  • Timestamp类型表示通道内用户数据对应JSON属性的取值为Timestamp类型,不需要进行数据格式转换就可以生成OpenTSDB的timestamp。- String类型表示通道内用户数据对应JSON属性的取值为Date格式,需要进行数据格式转换才能生成OpenTSDB的timestamp。

value

String

通道内用户数据的JSON属性名称。

取值范围:1~32,只能包含英文字母、数字和下划线。

format

String

“type”为“String”类型时必选。表示通道内用户数据对应JSON属性的取值为Date格式,需要根据format字段进行数据格式转换生成OpenTSDB的timestamp。取值范围:- yyyy/MM/dd HH:mm:ss- MM/dd/yyyy HH:mm:ss- dd/MM/yyyy HH:mm:ss- yyyy-MM-dd HH:mm:ss- MM-dd-yyyy HH:mm:ss- dd-MM-yyyy HH:mm:ss

枚举值:

  • yyyy/MM/dd HH:mm:ss

  • MM/dd/yyyy HH:mm:ss

  • dd/MM/yyyy HH:mm:ss

  • yyyy-MM-dd HH:mm:ss

  • MM-dd-yyyy HH:mm:ss

  • dd-MM-yyyy HH:mm:ss

表11 OpenTSDBValue

参数

是否必选

参数类型

描述

type

String

通道内用户JSON数据对应JSON属性的类型名称。

取值范围:

  • Bigint

  • Double

  • Boolean

  • Timestamp

  • String

  • Decimal

value

String

常量或通道内用户数据的JSON属性名称。

取值范围:1~32,只能包含英文字母、数字和下划线。

表12 OpenTSDBTags

参数

是否必选

参数类型

描述

name

String

存储该通道数据的OpenTSDB数据的tag名称。

取值范围:1~32,只能包含英文字母、数字和下划线。

type

String

通道内用户JSON数据对应JSON属性的类型名称。

取值范围:

  • Bigint

  • Double

  • Boolean

  • Timestamp

  • String

  • Decimal

value

String

常量或通道内用户数据的JSON属性名称。

取值范围:1~32,只能包含英文字母、数字和下划线。

响应参数

请求示例

  • 添加CloudTable HBase转储任务

    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
    
    {
      "destination_type" : "CLOUDTABLE",
      "cloudtable_destination_descriptor" : {
        "task_name" : "hbasetask",
        "consumer_strategy" : "TRIM_HORIZON",
        "agency_name" : "dis_admin_agency",
        "cloudtable_cluster_name" : "cloudtablecluster",
        "cloudtable_cluster_id" : "b8c095e2-db5f-4732-8a1d-eacd662e35dc",
        "cloudtable_table_name" : "cloudtabletable",
        "cloudtable_row_key_delimiter" : "|",
        "retry_duration" : 1800,
        "obs_backup_bucket_path" : "obsbackupbucket",
        "backup_file_prefix" : "",
        "cloudtable_schema" : {
          "row_key" : [ {
            "value" : "datavalue",
            "type" : "String"
          } ],
          "columns" : [ {
            "column_family_name" : "cfname1",
            "column_name" : "ID",
            "value" : "datavalue1",
            "type" : "String"
          }, {
            "column_family_name" : "cfname2",
            "column_name" : "VALUE",
            "value" : "datavalue2",
            "type" : "String"
          } ]
        }
      }
    }
  • 添加CloudTable OpenTSDB转储任务

    POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
    
    {
      "destination_type" : "CLOUDTABLE",
      "cloudtable_destination_descriptor" : {
        "task_name" : "opentsdbtask",
        "consumer_strategy" : "LATEST",
        "agency_name" : "dis_admin_agency",
        "cloudtable_cluster_name" : "cloudtablecluster",
        "cloudtable_cluster_id" : "b8c095e2-db5f-4732-8a1d-eacd662e35dc",
        "retry_duration" : 1800,
        "obs_backup_bucket_path" : "obsbackupbucket",
        "backup_file_prefix" : "",
        "opentsdb_schema" : [ {
          "metric" : [ {
            "type" : "Constant",
            "value" : "age"
          } ],
          "timestamp" : {
            "value" : "date",
            "type" : "String",
            "format" : "yyyy/MM/dd HH:mm:ss"
          },
          "value" : {
            "value" : "value",
            "type" : "Bigint"
          },
          "tags" : [ {
            "name" : "name",
            "value" : "name",
            "type" : "Bigint"
          } ]
        } ]
      }
    }

响应示例

状态码

状态码

描述

201

正常返回

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容