查询数据同步信息
URI
GET /v3/{project_id}/instances/{instance_id}/clickhouse/replication
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
|
instance_id |
是 |
String |
ClickHouse实例ID，严格匹配UUID规则。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
查询记录数，默认10。不能为负数，最小值为1，最大值为100。 |
|
offset |
否 |
Integer |
索引位置，偏移量，默认0。从第一条数据偏移offset条数据后开始查询（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围：
|
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
查询数据同步任务数。 |
|
replications |
Array of ChDatabaseReplicationInfo objects |
数据同步任务信息。 |
|
ext_text |
String |
taurus操作表示，重启、规格变更、倒换等。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
source_database |
String |
源数据库。 |
|
target_database |
String |
目标数据库。 |
|
status |
String |
当前状态。 取值范围：
|
|
stage |
String |
同步阶段。 取值范围：
|
|
percentage |
String |
进度百分比。 |
|
catchup_stage |
String |
追赶阶段。 取值范围：
|
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
查询第一页的前10个同步任务。
GET https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication?offset=1&limit=10
响应示例
状态码： 200
Success.
{
"total_count" : 3,
"replications" : [ {
"source_database" : "test",
"target_database" : "test",
"status" : "abnormal",
"stage" : "Full",
"percentage" : 0,
"catchup_stage" : null
}, {
"target_database" : "blackwhite_0018_61474479",
"status" : "normal",
"stage" : "Incremental",
"percentage" : 100,
"catchup_stage" : null
}, {
"target_database" : "blackwhite_0017_22525694",
"status" : "normal",
"stage" : "Wait",
"percentage" : 0,
"catchup_stage" : null
} ],
"ext_text" : null
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Success. |
|
400 |
Client error. |
|
500 |
Server error. |
错误码
请参见错误码。
