全部产品
Search
文档中心

云数据库 ClickHouse:CreateRDSToClickhouseDb - 创建同步任务

更新时间:Jul 17, 2024

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DbClusterIdstring

云数据库 ClickHouse 的集群 ID。

cc-2ze5zeyl72188****
ClickhousePortlong

云数据库 ClickHouse 的端口号。

8123
CkUserNamestring

云数据库 ClickHouse 的数据库账号。

user1
CkPasswordstring

云数据库 ClickHouse 的数据库账号密码。

123456Aa
RdsIdstring

云数据库 RDS MySQL 的实例 ID。

rm-8vb989qj9roh0****
RdsPortlong

云数据库 RDS MySQL 的端口号。

3306
RdsVpcIdstring

云数据库 RDS MySQL 的 VPC ID。

vpc-2zen93xryil99jsfy****
RdsUserNamestring

云数据库 RDS MySQL 的数据库账号。

user2
RdsPasswordstring

云数据库 RDS MySQL 的数据库账号密码。

123456Rr
SkipUnsupportedboolean

是否忽略不支持同步的表结构,取值说明:

  • true:忽略。
  • false:不忽略。
true
LimitUpperlong

每秒最多同步的行数。

50000
SynDbTablesstring

同步的表。

[{"Schema":"recommend","Tables":["mr_platform_cpm","mr_platform_ecpm","p_monitor_record"]}]
RdsVpcUrlstring

云数据库 RDS 的内网地址。

rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

66676F54-1994-5DCF-993F-74536649628A
Statuslong

创建是否成功,取值说明:

  • 1:创建成功。
  • 0:创建失败。同步任务中的表重复了,具体重复的表在 RepeatedDbs 参数中返回。
  • -1:创建失败。创建失败的原因在 ErrorMsg 参数中返回。
0
ErrorMsgstring

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
RepeatedDbsarray

同步任务中重复的表。

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错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
暂无变更历史