文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/查询数据库磁盘类型
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询数据库磁盘类型

接口说明

查询当前区域下的数据库磁盘类型。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/storage-type?engine_name={engine_name}

请求参数

表1 参数说明

名称

类型

IN

必选

描述

X-Auth-Token

string

header

是

用户Token。

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

engine_name

string

query

否

数据库版本类型。取值为“DDS-Community”。获取方法请参见查询数据库版本信息。

响应参数

表2 参数说明

名称

参数类型

是否必选

描述

storage_type

Array of objects

是

数据库磁盘信息列表。详情请参见表3。

dss_pool_info

Array of objects

是

实例dss_pool规格信息列表。详情请参见表4。

说明：

仅支持Dec用户查询。

表3 storage_type字段数据结构说明

名称

参数类型

是否必选

描述

name

String

是

磁盘类型名称，可能取值如下：

ULTRAHIGH，表示SSD。

EXTREMEHIGH，表示ESSD。

az_status

Map<String,String>

是

其中key是可用区编号，value是规格所在az的状态，包含以下状态：

  • normal，在售。
  • unsupported，暂不支持该磁盘类型。
  • sellout，售罄。
表4 dss_pool_info字段数据结构说明

名称

参数类型

是否必选

描述

az_name

String

是

dss_pool所在az名称。

free_capacity_gb

String

是

专属存储可用容量。

单位：GB。

dss_pool_volume_type

String

是

专属存储磁盘类型。

dss_pool_id

String

是

专属存储ID。

dss_pool_status

String

是

dss_pool的状态，包含以下状态：

  • available，可用。
  • deploying，正在部署。
  • enlarging，正在扩容。

响应示例中“az_status”字段下可用区“az1”、“az2”、“az3”均为示例值。

  • 响应示例 
    {
  "storage_type": [
    {
      "name": "ULTRAHIGH",
      "az_status": {
        "az1": "normal",
        "az2": "normal",
        "az3": "unsupported"
      }
    }
  ],
 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：API v3（推荐）