Querying the Database Disk Type

API Description

This API is used to query the database disk type in the current region.

URI

URI format
GET https://{Endpoint}/v3/{project_id}/storage-type?engine_name={engine_name}
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/storage-type?engine_name=DDS-Community

Requests

Request parameters

**Table 1** Parameter description
Name	Type	IN	Mandatory	Description
x-auth-token	string	header	Yes	User token obtained from IAM. For details, see Authentication.
project_id	string	path	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
engine_name	string	query	No	Specifies the database type. The value is DDS-Community. To obtain this value, see Querying Database Version Information.

Responses

Parameter description

**Table 2** Parameter description
Name	Type	Mandatory	Description
storage_type	Array of objects	Yes	Indicates the database disk information list. For more information, see Table 3.
dss_pool_info	Array of objects	Yes	Indicates the dss_pool specifications information list. For more information, see Table 4. NOTE: Only Dedicated Cloud (DeC) users are supported.

**Table 3** storage_type field data structure description
Name	Type	Mandatory	Description
name	String	Yes	Indicates the storage type. Its value can be: ULTRAHIGH: indicates the SSD type. EXTREMEHIGH indicates ESSD.
az_status	Map<String,String>	Yes	key indicates the AZ ID, and value indicates the specification status in the AZ. Its value can be any of the following: normal: indicates that the specifications are on sale. unsupported: The disk type is not supported. sellout: indicates the specifications are sold out.

**Table 4** dss_pool_info field data structure description
Name	Type	Mandatory	Description
az_name	String	Yes	Indicates the name of the AZ where the dss_pool is located.
free_capacity_gb	String	Yes	Indicates the available capacity of DSS. Unit: GB
dss_pool_volume_type	String	Yes	Indicates the disk type of DSS storage pool.
dss_pool_id	String	Yes	Indicates the DSS pool ID.
dss_pool_status	String	Yes	Indicates the dss_pool status. Its value can be any of the following: available deploying enlarging frozen sellout

In the example response, az1, az2, and az3 in the az_status field are example values.

Response example

{
  "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 user query response example

{
  "storage_type": [
    {
      "name": "ULTRAHIGH",
      "az_status": {
        "az1": "normal",
        "az2": "normal",
        "az3": "unsupported"
      }
    }
  ],
  "dss_pool_info": [
    {
      "az_name": "az1",
      "free_capacity_gb": "8656",
      "dss_pool_volume_type": "ULTRAHIGH",
      "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
      "dss_pool_status": "available"
    }
  ]
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.