huawei-cloud-api-definitions-GaussDB 0.1.20250124

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ChDatabaseReplicationInfo":{"description":"ClickHouse同步信息。","properties":{"catchup_stage":{"description":"追赶阶段。\n取值范围:\n- wait:等待同步\n- failed:同步失败\n- incremental:增量同步\n- full:全量同步\n- other:其他","type":"string"},"percentage":{"description":"进度百分比。","type":"string"},"source_database":{"description":"源数据库。","type":"string"},"stage":{"description":"同步阶段。\n取值范围:\n- wait:等待同步\n- failed:同步失败\n- incremental:增量同步\n- full:全量同步\n- other:其他","type":"string"},"status":{"description":"当前状态。\n取值范围:\n- normal:正常\n- abnormal:异常","type":"string"},"target_database":{"description":"目标数据库。","type":"string"}},"required":["source_database","target_database","status","stage","percentage","catchup_stage"],"type":"object"},"ChDatabaseReplicationListResponse":{"description":"查询数据同步任务响应体。","properties":{"ext_text":{"description":"taurus操作表示,重启、规格变更、倒换等。","type":"string"},"replications":{"description":"数据同步任务信息。","items":{"$ref":"#/definitions/ChDatabaseReplicationInfo"},"type":"array"},"total_count":{"description":"查询数据同步任务数。","format":"int32","type":"integer"}},"required":["total_count","replications","ext_text"],"type":"object"},"ErrorRsp":{"description":"失败时返回的错误对象","properties":{"error_code":{"description":"错误码。","example":"DBS.280292","type":"string"},"error_msg":{"description":"错误描述。","example":"数据库用户名非法","type":"string"}},"required":["error_code","error_msg"],"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"e1b17fbe22d543cab33b9c1ec0bf1e5f","info_version":"v3","method":"get","name":"ListClickHouseDataBaseReplication","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/clickhouse/replication":{"get":{"description":"查询数据同步信息。","operationId":"ListClickHouseDataBaseReplication","parameters":[{"description":"租户在某一Region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"ClickHouse实例ID,严格匹配UUID规则。","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"查询记录数,默认10。不能为负数,最小值为1,最大值为100。","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"description":"索引位置,偏移量,默认0。从第一条数据偏移offset条数据后开始查询(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"ext_text":null,"replications":[{"catchup_stage":null,"percentage":0,"source_database":"test","stage":"Full","status":"abnormal","target_database":"test"},{"catchup_stage":null,"percentage":100,"stage":"Incremental","status":"normal","target_database":"blackwhite_0018_61474479"},{"catchup_stage":null,"percentage":0,"stage":"Wait","status":"normal","target_database":"blackwhite_0017_22525694"}],"total_count":3}},"schema":{"$ref":"#/definitions/ChDatabaseReplicationListResponse"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/ErrorRsp"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/ErrorRsp"}}},"summary":"查询数据同步信息","tags":["HTAP-轻量版"],"x-is-registered":"Y","x-request-examples-description-1":"查询第一页的前10个同步任务。","x-request-examples-url-1":"GET https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication?offset=1&limit=10","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询数据同步信息","tags":"HTAP-轻量版","uri":null,"version":"2.0"}