{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ErrorRsp":{"description":"失败时返回的错误对象","properties":{"error_code":{"description":"错误码。","example":"DBS.280292","type":"string"},"error_msg":{"description":"错误描述。","example":"数据库用户名非法","type":"string"}},"required":["error_code","error_msg"],"type":"object"},"QueryDataReplicationListResponseV3":{"description":"查询数据同步任务响应体。","properties":{"ext_text":{"description":"扩展字段。","maxLength":10,"minLength":0,"type":"string"},"replications":{"description":"数据同步任务信息。","items":{"$ref":"#/definitions/StarRocksReplicationInfo"},"maxItems":50,"minItems":0,"type":"array"},"total_count":{"description":"查询数据同步任务数。","maxLength":3,"minLength":1,"type":"string"}},"type":"object"},"StarRocksReplicationInfo":{"description":"StarRocks同步任务信息。","properties":{"catchup_percentage":{"description":"追赶进度百分比。","maxLength":5,"minLength":2,"type":"string"},"catchup_stage":{"description":"追赶阶段。wait:等待同步;incremental:增量同步;full:全量同步;cancelled:删除;paused:暂停同步。","enum":["wait","incremental","full","cancelled","paused"],"maxLength":64,"minLength":3,"type":"string"},"percentage":{"description":"进度百分比。","maxLength":5,"minLength":2,"type":"string"},"source_database":{"description":"TaurusDB数据库。","maxLength":1024,"minLength":2,"type":"string"},"stage":{"description":"同步阶段。wait:等待同步;incremental:增量同步;full:全量同步;cancelled:删除;paused:暂停同步。","enum":["wait","incremental","full","cancelled","paused"],"maxLength":64,"minLength":3,"type":"string"},"status":{"description":"当前状态。Yes:正常;No:异常。","enum":["Yes","No"],"maxLength":5,"minLength":2,"type":"string"},"target_database":{"description":"目标数据库。","maxLength":128,"minLength":3,"type":"string"},"task_name":{"description":"同步任务名。","maxLength":128,"minLength":3,"type":"string"}},"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"89ab03c435354ffda63edda05a03f9fd","info_version":"v3","method":"get","name":"ListStarRocksDataReplications","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication":{"get":{"description":"查询StarRocks数据同步状态信息。","operationId":"ListStarRocksDataReplications","parameters":[{"description":"租户在某一Region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。","in":"path","maxLength":1024,"minLength":2,"name":"project_id","required":true,"type":"string"},{"description":"StarRocks实例ID,严格匹配UUID规则。","in":"path","maxLength":1024,"minLength":2,"name":"instance_id","required":true,"type":"string"},{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","maxLength":1024,"minLength":2,"name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":true,"type":"string"},{"description":"查询记录数。每页查询数据同步任务的数量。","in":"query","maxLength":3,"minLength":1,"name":"limit","required":false,"type":"string"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","in":"query","maxLength":100,"minLength":1,"name":"offset","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"ext_text":null,"replications":[{"catchup_percentage":0,"catchup_stage":null,"percentage":100,"source_database":"source_database","stage":"Incremental","status":"Yes","target_database":"target_database","task_name":"task_name"}],"total_count":1}},"schema":{"$ref":"#/definitions/QueryDataReplicationListResponseV3"}},"400":{"description":"Client error.","examples":{"application/json":{"error_code":"DBS.200022","error_msg":"实例不存在"}},"schema":{"$ref":"#/definitions/ErrorRsp"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/ErrorRsp"}}},"summary":"查询StarRocks数据同步状态信息","tags":["HTAP-标准版"],"x-apigateway-ratelimit":"gaussdbformysql01","x-is-registered":"Y","x-request-examples-description-1":"查询第一页的前10个同步任务。","x-request-examples-url-1":"GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication?offset=1&limit=10","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询StarRocks数据同步状态信息","tags":"HTAP-标准版","uri":null,"version":"2.0"}