调用CreateRDSToClickhouseDb创建同步任务_云数据库 ClickHouse-阿里云帮助中心

调用CreateRDSToClickhouseDb接口创建云数据库ClickHouse社区兼容版同步任务。

接口说明

说明

该接口仅适用于云数据库 ClickHouse 的社区兼容版集群。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

clickhouse:CreateRDSToClickhouseDb

create

*DBCluster

acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

无

请求参数

名称	类型	必填	描述	示例值
DbClusterId	string	是	云数据库 ClickHouse 的集群 ID。	cc-2ze5zeyl72188****
ClickhousePort	integer	否	云数据库 ClickHouse 的端口号。	8123
CkUserName	string	是	云数据库 ClickHouse 的数据库账号。	user1
CkPassword	string	是	云数据库 ClickHouse 的数据库账号密码。	123456Aa
RdsId	string	是	云数据库 RDS MySQL 的实例 ID。	rm-8vb989qj9roh0****
RdsPort	integer	否	云数据库 RDS MySQL 的端口号。	3306
RdsVpcId	string	否	云数据库 RDS MySQL 的 VPC ID。	vpc-2zen93xryil99jsfy****
RdsUserName	string	是	云数据库 RDS MySQL 的数据库账号。	user2
RdsPassword	string	是	云数据库 RDS MySQL 的数据库账号密码。	123456Rr
SkipUnsupported	boolean	是	是否忽略不支持同步的表结构，取值说明： true：忽略。 false：不忽略。	true
LimitUpper	integer	否	每秒最多同步的行数。	50000
SynDbTables	string	是	同步的表。	[{"Schema":"recommend","Tables":["mr_platform_cpm","mr_platform_ecpm","p_monitor_record"]}]
RdsVpcUrl	string	否	云数据库 RDS 的内网地址。	rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	66676F54-1994-5DCF-993F-74536649628A
Status	integer	创建是否成功，取值说明： 1：创建成功。 0：创建失败。同步任务中的表重复了，具体重复的表在 RepeatedDbs 参数中返回。 -1：创建失败。创建失败的原因在 ErrorMsg 参数中返回。	0
ErrorMsg	string	当 Status 参数返回为-1 时，返回创建失败的原因。	ClickHouse exception, code: 49, host: 100.100.79.102, port: 14540; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n
RepeatedDbs	array	同步任务中重复的表。
	string	当 Status 返回为 0 时，返回创建同步任务中重复的表。	["mr_platform_cpm","mr_platform_ecpm"]

示例

正常返回示例

JSON格式

{
  "RequestId": "66676F54-1994-5DCF-993F-74536649628A",
  "Status": 0,
  "ErrorMsg": "ClickHouse exception, code: 49, host: 100.100.79.102, port: 14540; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n",
  "RepeatedDbs": [
    "[\"mr_platform_cpm\",\"mr_platform_ecpm\"]"
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。