更新时间:2023-11-08 GMT+08:00
分享

查询数据库磁盘类型

接口说明

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

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

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

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/storage-type?engine_name=DDS-Community

请求消息

请求参数
表1 参数说明

名称

类型

IN

必选

描述

x-auth-token

string

header

从IAM服务获取的用户Token。请参考认证鉴权

project_id

string

path

租户在某一Region下的项目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,正在扩容。
    • frozen,冻结。
    • sellout,售罄。

    响应示例中“az_status”字段下可用区的值为示例值。

  • 响应示例
    {
      "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,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档