huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20250523

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"DedicatedResourceCapacity":{"description":"专属资源信息容量信息。","properties":{"ram":{"description":"内存大小,单位GB。","example":4,"type":"integer"},"vcpus":{"description":"CPU核数。","example":2,"type":"integer"},"volume":{"description":"存储大小,单位GB","example":3000000,"type":"integer"}},"required":["vcpus","ram","volume"]},"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"ListDedicatedResourceBody":{"properties":{"resources":{"description":"专属资源信息列表。","items":{"$ref":"#/definitions/ListDedicatedResourceResult"},"type":"array"},"total_count":{"description":"总记录数。","type":"integer"}},"required":["total_count","resources"]},"ListDedicatedResourceResult":{"description":"专属资源信息列表。","properties":{"architecture":{"description":"专属资源的计算架构。","example":"X86","type":"string"},"availability_zone":{"description":"可用区信息。","example":"az1,az2,az3","type":"string"},"capacity":{"$ref":"#/definitions/DedicatedResourceCapacity","description":"专属资源的容量信息。"},"engine_name":{"description":"引擎名称。","example":"cassandra","type":"string"},"id":{"description":"专属资源ID。","example":"300acc71-eca9-4c6b-9a4e-0d25e20fe54c","type":"string"},"resource_name":{"description":"专属资源的名称。","example":"nosql-dedicated-resource-1","type":"string"},"status":{"description":"专属资源的状态信息。","example":"NORMAL","type":"string"}},"required":["id","resource_name","engine_name","availability_zone","architecture","capacity","status"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"6c856fed52244ceda86cbc7cc5ee636a","info_version":"v3","method":"get","name":"ListDedicatedResources","parameters":{},"paths":{"/v3/{project_id}/dedicated-resources":{"get":{"description":"查询专属资源列表。","operationId":"ListDedicatedResources","parameters":[{"description":"用户Token。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"租户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"索引位置偏移量。\n  - 索引位置偏移量,表示从指定project ID下最新的专属资源创建时间开始,按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。\n  - 取值大于或等于0。\n  - 不传该参数时,查询偏移量默认为0,表示从最新的创建时间对应的专属资源开始查询。","in":"query","name":"offset","required":false,"type":"integer","x-example":0},{"description":"查询专属资源个数上限值。\n  - 取值范围:1~100。不传该参数时,默认查询前100条实例信息。","in":"query","name":"limit","required":false,"type":"integer","x-example":10}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"resources":[{"architecture":"X86","availability_zone":"az1,az2,az3","capacity":{"ram":1536,"vcpus":192,"volume":300000},"engine_name":"cassandra","id":"300acc71-eca9-4c6b-9a4e-0d25e20fe54c","resource_name":"nosql-dedicated-resource-1","status":"NORMAL"},{"architecture":"X86","availability_zone":"az1,az2,az3","capacity":{"ram":1536,"vcpus":192,"volume":300000},"engine_name":"cassandra","id":"4c423cd8-551f-4b74-934f-8534e4a9bf2b","resource_name":"nosql-dedicated-resource-2","status":"BUILDING"}],"total_count":2}},"schema":{"$ref":"#/definitions/ListDedicatedResourceBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"查询专属资源列表","tags":["查询专属资源列表"],"x-apigateway-ratelimit":"nosql_default_policy","x-constraint":"该接口支持获取如下数据库引擎的专属资源列表:\n  - GeminiDB Cassandra","x-is-registered":"Y","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dedicated-resources","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询专属资源列表","tags":"查询专属资源列表","uri":null,"version":"2.0"}