
# 查询数据库磁盘类型-QueryingtheDatabaseDiskType
#### 功能介绍
查询当前区域下的数据库磁盘类型。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ListStorageType)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                          | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:listStorageType | read | -           | -   | -  | -      |
     
  
 
#### URI
- URI格式 GET /v3/{project_id}/storage-type
  
- URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/storage-type?engine_name=DDS-Community
  
 
表1路径参数 
| 名称         | 是否必选 | 类型     | IN   | 描述                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|:---|
| project_id | 是    | string | path | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表2Query参数 
| 名称          | 是否必选 | 类型     | IN    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|:---|
| engine_name | 否    | string | query | **参数解释：** 数据库版本类型。获取方法请参见[查询数据库版本信息-QueryingDatabaseVersionInformation](https://support.huaweicloud.com/api-dds/dds_database_version.html)。 **约束限制：** 取值为"DDS-Community"。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求参数
表3请求Header参数 
| 名称           | 是否必选 | 类型     | IN     | 描述                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|:---|
| x-auth-token | 是    | string | header | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
表4参数说明 
| 名称            | 是否必选 | 参数类型             | 描述                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| storage_type  | 是    | Array of objects | **参数解释：** 数据库磁盘信息列表。详情请参见[表5]。 **取值范围：** 不涉及。                                                   |
| dss_pool_info | 是    | Array of objects | **参数解释：** 实例专属存储规格信息列表。详情请参见[表6]。 说明： 仅支持Dec用户查询。 **取值范围：** 不涉及。 |
   
 表5storage_type字段数据结构说明 
| 名称        | 是否必选 | 参数类型                 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| name      | 是    | String               | **参数解释：** 磁盘类型名称。 **取值范围：** - ULTRAHIGH，表示SSD。  - EXTREMEHIGH，表示ESSD。                                                                                                                |
| az_status | 是    | Map\<String,String\> | **参数解释：** 其中key是可用区编号，value是规格所在az的状态。 **取值范围：** - normal，在售。  - unsupported，暂不支持该磁盘类型。  - sellout，售罄。   |
   
 表6dss_pool_info字段数据结构说明 
| 名称                   | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| az_name              | 是    | String | **参数解释：** 专属存储池所在az。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| free_capacity_gb     | 是    | String | **参数解释：** 专属存储可用容量。单位：GB。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| dss_pool_volume_type | 是    | String | **参数解释：** 专属存储磁盘类型。 **取值范围：** - ULTRAHIGH，表示SSD。  - EXTREMEHIGH，表示ESSD。                                                                                                                                                                                                                                             |
| dss_pool_id          | 是    | String | **参数解释：** 专属存储ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| dss_pool_status      | 是    | String | **参数解释：** 专属存储池当前状态。 **取值范围：** - available，可用。  - deploying，正在部署。  - enlarging，正在扩容。  - frozen，冻结。  - sellout，售罄。   |
   
![](https://support.huaweicloud.com/api-dds/public_sys-resources/note_3.0-zh-cn.png)
响应示例中"az_status"字段下可用区的值为示例值。
#### 请求示例
```
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/storage-type
```
#### 响应示例
```
{
  "storage_type": [
    {
      "name": "ULTRAHIGH",
      "az_status": {
        "az1": "normal",
        "az2": "normal"
      }
    }
  ],
  "dss_pool_info": [
    {
      "az_name": "az1xahz",
      "free_capacity_gb": "150",
      "dss_pool_volume_type": "ULTRAHIGH",
      "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4df",
      "dss_pool_status": "available"
    }
  ]
}
```
- Dec用户查询响应示例
  ```
  {
    "storage_type": [
      {
        "name": "ULTRAHIGH",
        "az_status": {
          "cn-north-1a": "normal",
          "cn-north-1b": "normal",
          "cn-north-1c": "unsupported"
        }
      }
    ],
    "dss_pool_info": [
      {
        "az_name": "cn-north-1a",
        "free_capacity_gb": "8656",
        "dss_pool_volume_type": "ULTRAHIGH",
        "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
        "dss_pool_status": "available"
      }
    ]
  }
  ```
  
 
#### 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)。
