文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（推荐）/ HTAP-轻量版/ 创建数据同步
更新时间：2024-08-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建数据同步

功能介绍

创建数据同步。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/instances/{instance_id}/clickhouse/replication

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

ClickHouse实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us

  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

source_instance_id

是

String

源实例ID。

source_node_id

否

String

源节点ID。GaussDB(for MySQL)只读节点ID。如为空，则取GaussDB(for MySQL)主节点ID。

source_database

是

String

源数据库。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

创建的任务ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

创建ClickHouse数据同步。

POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication

{
  "source_instance_id" : "source_instance_id",
  "source_node_id" : "source_node_id",
  "source_database" : "source_database"
}

响应示例

状态码： 200

Success.

{
  "job_id" : "18ef8ee3-b880-4851-8978-bb6acbd4e695"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： HTAP-轻量版

相关文档