huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20260619

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"ListFlavorsResponseBody":{"properties":{"flavors":{"description":"实例规格信息列表。","items":{"$ref":"#/definitions/ListFlavorsResult"},"type":"array"},"total_count":{"description":"总记录数。","type":"integer"}},"required":["total_count","flavors"]},"ListFlavorsResult":{"description":"实例规格信息列表。","properties":{"availability_zone":{"description":"支持该规格的可用区ID。\n  - 该字段已废弃,请不要使用。","items":{"type":"string"},"type":"array"},"az_status":{"description":"规格在可用区内的状态,包含以下状态:\n  - normal,在售。\n  - unsupported,暂不支持该规格。\n  - sellout,售罄。","type":"object"},"engine_name":{"description":"引擎名称。","example":"cassandra","type":"string"},"engine_version":{"description":"引擎版本。","example":"3.11","type":"string"},"ram":{"description":"内存大小,单位为兆字节。","example":4,"type":"string"},"spec_code":{"description":"资源规格编码。例如:geminidb.cassandra.8xlarge.4\n  - “geminidb.cassandra”表示云数据库GeminiDB的Cassandra数据库产品。\n  - “8xlarge.4”表示节点性能规格。","example":"geminidb.cassandra.8xlarge.4","type":"string"},"vcpus":{"description":"CPU核数。","example":"2","type":"string"}},"required":["engine_name","engine_version","vcpus","ram","spec_code","availability_zone","az_status"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"f07e19052b97466497d4b604485dc42d","info_version":"v3","method":"get","name":"ListFlavorInfos","parameters":{},"paths":{"/v3.1/{project_id}/flavors":{"get":{"description":"查询指定条件下的实例规格信息。","operationId":"ListFlavorInfos","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  - 取值为“cassandra”,表示查询GeminiDB Cassandra数据库实例支持的规格。\n  - 取值为“mongodb”,表示查询GeminiDB Mongo数据库实例支持的规格。\n  - 取值为“influxdb”,表示查询GeminiDB Influx数据库实例支持的规格。\n  - 取值为“redis”,表示查询GeminiDB Redis数据库实例支持的规格。\n  - 如果不传该参数,默认为“cassandra”。","in":"query","name":"engine_name","type":"string","x-example":"cassandra"},{"description":"- 取值为“CloudNativeCluster”, 表示查询云原生部署模式支持的规格。\n- 不传该参数表示查询数据库类型下的所有经典部署模式支持的规格。","in":"query","name":"mode","type":"string","x-example":"Cluster"},{"description":"产品类型。\n  - Standard 标准型\n  - Capacity 容量型\n当创建GeminiDB Redis云原生部署模式集群类型必传此参数。","in":"query","name":"product_type","type":"string"},{"description":"索引位置,偏移量。\n  - 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。\n  - 取值必须为数字,不能为负数。","in":"query","name":"offset","type":"integer","x-example":0},{"description":"查询规格信息上限值。\n  - 取值范围: 1~100。\n  - 不传该参数时,默认查询前100条规格信息。","in":"query","name":"limit","type":"integer","x-example":100}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"flavors":[{"availability_zone":["az1","az2"],"az_status":{"az1":"normal","az2":"unsupported"},"engine_name":"cassandra","engine_version":"3.11","ram":"16","spec_code":"geminidb.cassandra.xlarge.4","vcpus":"4"},{"availability_zone":["az1","az2"],"az_status":{"az1":"unsupported","az2":"normal"},"engine_name":"cassandra","engine_version":"3.11","ram":"32","spec_code":"geminidb.cassandra.2xlarge.4","vcpus":"8"}],"total_count":2}},"schema":{"$ref":"#/definitions/ListFlavorsResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"查询数据库规格","tags":["查询所有实例规格信息"],"x-constraint":"该接口支持如下数据库实例:\n- GeminiDB Cassandra\n- GeminiDB Mongo\n- GeminiDB Influx\n- GeminiDB Redis","x-is-registered":"Y","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://{endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/flavors?engine_name=cassandra&offset=0&limit=10","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询数据库规格","tags":"查询所有实例规格信息","uri":null,"version":"2.0"}