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":{"CreateDataReplicationResponseV3":{"description":"创建数据同步任务响应体。","properties":{"job_id":{"description":"创建数据同步的任务ID。","maxLength":64,"minLength":2,"type":"string"}},"type":"object"},"CreateStarRocksDataReplication":{"description":"StarRocks创建数据同步请求。","properties":{"source_database":{"description":"源数据库。","maxLength":1024,"minLength":2,"type":"string"},"source_instance_id":{"description":"TaurusDB实例ID。","maxLength":1024,"minLength":2,"type":"string"},"source_node_id":{"description":"TaurusDB只读节点ID。如为空,则取TaurusDB主节点ID","maxLength":1024,"minLength":0,"type":"string"},"target_database":{"description":"目标数据库。\n字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线_。","maxLength":128,"minLength":3,"type":"string"},"task_name":{"description":"同步任务名。\n字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线_。","maxLength":128,"minLength":3,"type":"string"}},"required":["source_instance_id","source_database","target_database","task_name"],"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":"5e88d3494d37442db5982a94ad7f3bb6","info_version":"v3","method":"post","name":"CreateStarRocksDataReplication","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication":{"post":{"description":"创建StarRocks数据同步。","operationId":"CreateStarRocksDataReplication","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":"数据同步创建任务请求体。","in":"body","name":"CreateStarRocksDataReplicationRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateStarRocksDataReplication"}},{"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"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"job_id":"123"}},"schema":{"$ref":"#/definitions/CreateDataReplicationResponseV3"}},"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-1":{"source_database":"source_database","source_instance_id":"source_instance_id","source_node_id":"source_node_id","target_database":"target_database","task_name":"task_name"},"x-request-examples-text-1":{"source_database":"source_database","source_instance_id":"source_instance_id","source_node_id":"source_node_id","target_database":"target_database","task_name":"task_name"},"x-request-examples-url-1":"POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication","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"}