
# 查询数据库规格-QueryingDatabaseSpecifications
#### 功能介绍
查询指定条件下的实例规格信息。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ListFlavorInfos)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                      | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:listFlavors | read | -           | -   | -  | -      |
     
  
 
#### URI
- URI格式 GET /v3.1/{project_id}/flavors
  
- URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3.1/0549b4a43100d4f32f51c01c2fe4acdb/flavors?engine_name=DDS-Community\&engine_version=3.4\&offset=1\&limit=20
  
 
#### 请求参数
表1参数说明 
| 名称             | 类型      | IN     | 必选 | 描述                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|:---|
| x-auth-token   | string  | header | 是  | 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。                                                                                                                                                                                                                                                                      |
| project_id     | string  | path   | 是  | 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。                                                                                                                                                                                                                                                          |
| engine_name    | string  | query  | 否  | 数据库版本类型。取值为"DDS-Community"。获取方法请参见[查询数据库版本信息-QueryingDatabaseVersionInformation](https://support.huaweicloud.com/api-dds/dds_database_version.html)。                                                                                                                                                                                                        |
| engine_version | string  | query  | 否  | 数据库版本号。                                                                                                                                                                                                                                                                                                                                                     |
| offset         | Integer | query  | 否  | 索引位置，偏移量。 - 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据,表示从第一条数据开始查询）。  - 取值必须为数字，不能为负数。   |
| limit          | Integer | query  | 否  | 查询规格信息上限值。 - 取值范围：1\~100。  - 不传该参数时，默认查询前100条规格信息。                                     |
   
#### 响应参数
表2参数说明 
| 名称          | 参数类型             | 是否必选 | 描述                                                              |
|:---|:---|:---|:---|
| flavors     | Array of objects | 是    | 实例规格信息列表。详情请参见[表3]。 |
| total_count | Integer          | 是    | 总记录数。                                                           |
   
 表3flavors字段数据结构说明 
| 名称              | 参数类型                 | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| 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 说明： - "dds"表示文档数据库服务产品。  - "dds.mongodb"表示文档数据库服务产品。  - "c6.xlarge.2"表示节点性能规格，为高内存类型。  - "shard"表示节点类型。  - 查询规格时，注意区分是否为同系列的规格。规格系列包括：通用型（s6）、增强型（c3）、增强Ⅱ型（c6）。 示例： - dds.mongodb.s6.large.4.mongos和dds.mongodb.s6.large.4.config是同一规格系列。  - dds.mongodb.s6.large.4.mongos和dds.mongodb.c3.large.4.config不是同一规格系列。      |
| 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/api-dds/public_sys-resources/note_3.0-zh-cn.png)
响应示例中"az_status"字段下可用区的值为示例值。
- 响应示例
  ```
  {
      "total_count":5,
      "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": {
                  "cn-north-1a": "unsupported",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "unsupported"
              }
          },
  {
              "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": {
                  "cn-north-1a": "sellout",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "unsupported"
              }
          },
    {
              "engine_name": "DDS-Community",
              "type": "config",
              "vcpus": "2",
              "ram": "4",
              "spec_code": "dds.mongodb.c6.large.2.config",
              "engine_versions":["3.4"],
              "az_status": {
                  "cn-north-1a": "normal",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "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": {
                  "cn-north-1a": "normal",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "normal"
              }
          },
  {
              "engine_name": "DDS-Community",
              "type": "single",
              "vcpus": "16",
              "ram": "64",
              "spec_code": "dds.mongodb.c6.4xlarge.4.single",
              "engine_versions":["3.4","4.0"],
              "az_status": {
                  "cn-north-1a": "normal",
                  "cn-north-1b": "normal",
                  "cn-north-1c": "normal",
                  "cn-north-1a,cn-north-1b,cn-north-1c": "normal"
              }
          }
      ]
  }
  ```
  
 
#### SDK
单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
#### 状态码
详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。
#### 错误码
详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。
