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":{"CheckResourceInfo":{"description":"资源信息。","properties":{"availability_zone":{"description":"可用区码。","type":"string"},"availability_zone_mode":{"description":"可用区类型,单可用区single或多可用区multi。action为createInstance时必填。","type":"string"},"enterprise_project_id":{"description":"企业项目ID。action为createInstance时必填。","type":"string"},"flavor_ref":{"description":"规格码。action为createInstance、resizeFlavor时必填。","type":"string"},"instance_id":{"description":"实例ID。action为createReadonlyNode、resizeFlavor时必填。","type":"string"},"instance_num":{"description":"实例数量。action为createInstance时必填。","type":"integer"},"mode":{"description":"实例类型,目前仅支持Cluster。action为createInstance时必填。","type":"string"},"node_num":{"description":"节点数量。action为createInstance、createReadonlyNode时必填。","type":"integer"},"subnet_id":{"description":"子网ID。action为createInstance时必填。","type":"string"}}},"CheckResourceRequestBody":{"properties":{"action":{"description":"校验类型。\n- createInstance:校验创建实例。\n- createReadonlyNode:校验创建只读节点。\n- resizeFlavor:校验规格变更。","type":"string"},"resource":{"$ref":"#/definitions/CheckResourceInfo"}},"required":["action","resource"]},"CheckResourceResp":{"properties":{"result":{"description":"结果。\n- true:表示通过。\n- false:表示不通过。","type":"boolean"}}},"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"e7a2dee53abd49efb2f06158ce584454","info_version":"v3","method":"post","name":"CheckResource","parameters":{},"paths":{"/v3/{project_id}/resource-check":{"post":{"description":"资源预校验。","operationId":"CheckResource","parameters":[{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。\n","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"内容类型。\n\n取值:application/json。\n","in":"header","name":"Content-Type","required":true,"type":"string","x-example":"application/json"},{"description":"租户在某一Region下的project ID。                          \n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"请求体。","in":"body","name":"CheckResourceRequestBody","required":true,"schema":{"$ref":"#/definitions/CheckResourceRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"result":true}},"schema":{"$ref":"#/definitions/CheckResourceResp"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}}},"summary":"资源预校验","tags":["实例管理"],"x-is-registered":"N","x-request-examples-1":{"action":"createInstance","resource":{"availability_zone":"cn-southwest-244b","availability_zone_mode":"single","enterprise_project_id":0,"flavor_ref":"gaussdb.mysql.xlarge.x86.4","instance_num":1,"mode":"Cluster","node_num":2,"subnet_id":"1e9f71dd-9192-4c0d-9739-161d8dcca68c"}},"x-request-examples-2":{"action":"createReadonlyNode","resource":{"instance_id":"376e0847a2224e95afcd3e607eccd544in07","node_num":1}},"x-request-examples-3":{"action":"resizeFlavor","resource":{"flavor_ref":"gaussdb.mysql.xlarge.x86.4","instance_id":"376e0847a2224e95afcd3e607eccd544in07"}},"x-request-examples-description-1":"创建实例资源预校验。","x-request-examples-description-2":"添加只读资源预校验。","x-request-examples-description-3":"规格变更资源预校验。","x-request-examples-url-1":"POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check","x-request-examples-url-2":"POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check","x-request-examples-url-3":"POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"资源预校验","tags":"实例管理","uri":null,"version":"2.0"}