更新时间:2024-09-11 GMT+08:00

创建StarRocks数据同步

功能介绍

创建StarRocks数据同步。

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

StarRocks实例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

GaussDB(for MySQL)实例ID。

source_node_id

String

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

source_database

String

源数据库。字符长度限制3~1024位,仅支持英文大小写字母、数字以及下划线。

target_database

String

目标数据库。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

task_name

String

同步任务名。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

响应参数

状态码: 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

错误描述。

请求示例

POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication

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

响应示例

状态码: 200

Success.

{
  "job_id" : "123"
}

状态码: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "实例不存在"
}

状态码

请参见状态码

错误码

请参见错误码