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":{"DataBaseInfo":{"description":"数据库校验信息。","properties":{"database_name":{"description":"数据库名称。","maxLength":64,"minLength":2,"type":"string"},"db_config_check_results":{"description":"数据库配置检查结果。","items":{"$ref":"#/definitions/DbConfigCheckResult"},"maxItems":5000,"minItems":0,"type":"array"}},"type":"object"},"DbConfigCheckResult":{"description":"库配置校验检查结果。","properties":{"check_result":{"description":"校验结果。","enum":["success","fail"],"maxLength":1024,"minLength":1,"type":"string"},"param_name":{"description":"参数名。","maxLength":128,"minLength":2,"type":"string"},"value":{"description":"参数值。","maxLength":64,"minLength":1,"type":"string"}},"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"},"QueryDataReplicationConfigResponseV3":{"description":"查询数据同步配置响应体。","properties":{"database_info":{"$ref":"#/definitions/DataBaseInfo","description":"TaurusDB数据库配置信息。"},"is_tables_change":{"description":"同步任务表是否变化。","type":"boolean"},"last_error_of_alter_table":{"description":"最近一次alter table的异常信息。","maxLength":1024,"minLength":0,"type":"string"},"new_table_repl_config":{"$ref":"#/definitions/TableReplConfig","description":"更新的表同步配置信息。"},"source_instance_id":{"description":"TaurusDB实例ID。","maxLength":1024,"minLength":2,"type":"string"},"source_node_id":{"description":"TaurusDB节点ID。","maxLength":1024,"minLength":2,"type":"string"},"table_infos":{"description":"表配置信息。","items":{"$ref":"#/definitions/TableConfigCheckResult"},"maxItems":50,"minItems":0,"type":"array"},"table_repl_config":{"$ref":"#/definitions/TableReplConfig","description":"表同步配置信息。"},"target_database_name":{"description":"目标数据库名。","maxLength":64,"minLength":3,"type":"string"}},"type":"object"},"TableConfigCheckResult":{"description":"表配置校验结果。","properties":{"check_result":{"description":"校验结果。","maxLength":10,"minLength":2,"type":"string"},"table_config":{"description":"表配置项。","maxLength":1024,"minLength":2,"type":"string"},"table_name":{"description":"表名。","maxLength":1024,"minLength":2,"type":"string"}},"type":"object"},"TableReplConfig":{"description":"表同步配置。","properties":{"repl_scope":{"default":"all","description":"表同步范围。all:全量同步,part:部分同步。","enum":["all","part"],"maxLength":5,"minLength":3,"type":"string"},"repl_type":{"description":"表同步类型。include_tables:白名单,exclude_tables:黑名单。","enum":["include_tables","exclude_tables"],"maxLength":15,"minLength":2,"type":"string"},"tables":{"description":"白名单或黑名单的表范围。","items":{"maxLength":1024,"minLength":2,"type":"string"},"maxItems":5000,"minItems":0,"type":"array"}},"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"551048ef062a4bc390c8831a7ce2abb3","info_version":"v3","method":"get","name":"ListStarRocksDataReplicationConfig","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration":{"get":{"description":"查询StarRocks数据同步配置信息。","operationId":"ListStarRocksDataReplicationConfig","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":"数据同步任务名。\n字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线_。","in":"query","maxLength":128,"minLength":3,"name":"task_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"database_info":{"database_name":"database_name","db_config_check_results":[{"check_result":"success","param_name":"default_isolation_level","value":"QUERY_SNAPSHOT"},{"check_result":"failed","param_name":"enable_snapshots","value":"true"}]},"is_tables_change":false,"last_error_of_alter_table":"","new_table_repl_config":{},"source_instance_id":"source_instance_id","source_node_id":"source_node_id","table_info":[],"table_repl_config":{"repl_scope":"all","repl_type":"exclude_tables","tables":[]},"target_database_name":"target_database_name"}},"schema":{"$ref":"#/definitions/QueryDataReplicationConfigResponseV3"}},"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":"查询任务名为taskName的数据同步配置信息。","x-request-examples-url-1":"GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration?task_name=taskName","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"}