查询数据库规格
接口说明
查询指定条件下的实例规格信息。
URI
- URI格式
GET https://{Endpoint}/v3.1/{project_id}/flavors?engine_name={engine_name}&engine_version={engine_version}&offset={offset}&limit={limit}
- URI样例
https://dds.ap-southeast-1.myhuaweicloud.com/v3.1/0549b4a43100d4f32f51c01c2fe4acdb/flavors?engine_name=DDS-Community&engine_version=3.4&offset=1&limit=20
请求消息
名称 |
类型 |
IN |
必选 |
描述 |
---|---|---|---|---|
x-auth-token |
string |
header |
是 |
从IAM服务获取的用户Token。请参考认证鉴权。 |
project_id |
string |
path |
是 |
租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 |
engine_name |
string |
query |
否 |
数据库版本类型。取值为“DDS-Community”。获取方法请参见查询数据库版本信息。 |
engine_version |
string |
query |
否 |
数据库版本号。 |
offset |
Integer |
query |
否 |
索引位置,偏移量。
|
limit |
Integer |
query |
否 |
查询规格信息上限值。
|
响应消息
- 参数说明
表2 参数说明 名称
参数类型
是否必选
描述
flavors
Array of objects
是
实例规格信息列表。详情请参见表3。
total_count
Integer
是
总记录数。
表3 flavors字段数据结构说明 名称
参数类型
是否必选
描述
engine_name
String
是
引擎名称。
type
String
是
节点类型。文档数据库包含以下几种节点类型:
- mongos
- shard
- config
- replica
- single
- readonly
vcpus
String
是
CPU核数。
ram
String
是
内存大小,单位为GB。
spec_code
String
是
资源规格编码。
示例:dds.mongodb.c6.xlarge.2.shard
az_status
Map<String,String>
是
其中key是可用区编号,value是规格所在az的状态,包含以下状态:
- normal,在售。
- unsupported,暂不支持该规格类型。
- sellout,售罄。
engine_versions
Array of strings
是
数据库版本号列表。
针对DDS引擎的mongos节点,例如:{"3.4", "4.0"}
![](https://support.huaweicloud.com/intl/zh-cn/api-dds/public_sys-resources/note_3.0-zh-cn.png)
响应示例中“az_status”字段下可用区“az1”、“az2”、“az3”均为示例值。
- 响应示例
{ "total_count":4, "flavors": [ { "engine_name": "DDS-Community", "type": "mongos", "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.c6.medium.4.mongos", "engine_versions":["3.4","4.0"], "az_status": { "az1": "normal", "az2": "normal", "az3": "normal" } }, { "engine_name": "DDS-Community", "type": "shard", "vcpus": "4", "ram": "8", "spec_code": "dds.mongodb.c6.xlarge.2.shard", "engine_versions":["3.4","4.0"], "az_status": { "az1": "normal", "az2": "normal", "az3": "normal" } }, { "engine_name": "DDS-Community", "type": "config", "vcpus": "2", "ram": "4", "spec_code": "dds.mongodb.c6.large.2.config", "engine_versions":["3.4","4.0"], "az_status": { "az1": "normal", "az2": "normal", "az3": "normal" } }, { "engine_name": "DDS-Community", "type": "replica", "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.c6.medium.4.repset", "engine_versions":["3.4","4.0"], "az_status": { "az1": "normal", "az2": "normal", "az3": "normal" } } ] }
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。