暂停StarRocks数据同步
URI
POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/pause
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
StarRocks实例ID,严格匹配UUID规则。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_name |
是 |
String |
同步任务名。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
暂停数据同步的任务ID。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/pause { "task_name" : "task_name" }
响应示例
状态码: 200
Success
{ "job_id" : "123" }
状态码: 400
Client error.
{ "error_code" : "DBS.200022", "error_msg" : "实例不存在" }
状态码
状态码 |
描述 |
---|---|
200 |
Success |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。