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":{"CheckResult":{"properties":{"result":{"description":"检查结果。","example":true,"type":"boolean"}},"type":"object"},"Erro":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200082","type":"string"},"error_msg":{"description":"错误消息。","example":"The available IP addresses in the selected subnet are insufficient.","type":"string"}},"type":"object"},"ResourceCheck":{"properties":{"action":{"description":"校验类型,仅支持校验创建实例。","enum":["createInstance"],"example":"createInstance","type":"string"},"resource":{"description":"资源信息。","properties":{"availability_zone":{"description":"可用区码。选填,校验可用区码是否正确。","example":"cn-southwest-244d","type":"string"},"availability_zone_mode":{"description":"可用区类型,目前仅支持single。","example":"single","type":"string"},"be_flavor_ref":{"description":"BE规格码。","example":"gaussdb.sr-be.8xlarge.x86.4","type":"string"},"be_node_num":{"description":"BE节点数量。","example":3,"format":"int32","type":"integer"},"enterprise_project_id":{"description":"企业项目ID。","example":0,"type":"string"},"fe_flavor_ref":{"description":"FE规格码。","example":"gaussdb.sr-fe.16xlarge.x86.4","type":"string"},"fe_node_num":{"description":"FE节点数量。","example":3,"format":"int32","type":"integer"},"instance_num":{"description":"实例数量。","example":1,"format":"int32","type":"integer"},"mode":{"description":"实例部署模式。","enum":["Cluster","Single"],"example":"Cluster","type":"string"},"subnet_id":{"description":"HTAP实例子网即TaurusDB实例子网。\n获取方法请参见[获取子网ID](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。","example":"8926baca-467a-4556-8603-b4077805ff9d","type":"string"}},"required":["enterprise_project_id","instance_num","mode","availability_zone_mode","fe_node_num","be_node_num","fe_flavor_ref","be_flavor_ref","subnet_id"]}},"required":["action","resource"],"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"f4e8dc3e5d684324ac66d45a3e1686ee","info_version":"v3","method":"post","name":"CheckStarRocksResource","parameters":{},"paths":{"/v3/{project_id}/starrocks/resource-check":{"post":{"description":"StarRocks资源检查。","operationId":"CheckStarRocksResource","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":"用户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":"内容类型。\n\n取值:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":false,"type":"string"},{"description":"资源检查。","in":"body","name":"CheckStarRocksResourceRequestBody","required":true,"schema":{"$ref":"#/definitions/ResourceCheck"}}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"result":true}},"schema":{"$ref":"#/definitions/CheckResult"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/Erro"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/Erro"}}},"summary":"StarRocks资源检查","tags":["HTAP-标准版"],"x-is-registered":"Y","x-request-examples-description-1":"StarRocks实例资源检查","x-request-examples-url-1":"POST https://{endpoint}/v3/8f26bcbd59e84e1d9e0569c32545cee9/starrocks/resource-check","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"}