Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ Querying the Database Disk Type
Updated on 2025-10-24 GMT+08:00
View PDF

Querying the Database Disk Type

Function

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

URI

  • URI format

    GET /v3/{project_id}/storage-type

  • URI example

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

Table 1 Path parameters

Name

Mandatory

Type

IN

Description

project_id

Yes

string

path

Definition

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query parameters

Name

Mandatory

Type

IN

Description

engine_name

No

string

query

Definition

Specifies the database type. To obtain this value, see Querying Database Version Information.

Constraints

The value is DDS-Community.

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Name

Mandatory

Type

IN

Description

x-auth-token

Yes

string

header

Definition

User token obtained from IAM. For details, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 4 Parameter description

Name

Mandatory

Type

Description

storage_type

Yes

Array of objects

Definition

Indicates the database disk information list. For more information, see Table 5.

Range

N/A

dss_pool_info

Yes

Array of objects

Definition

Indicates the dedicated storage specifications information list. For more information, see Table 6.

NOTE:

Only Dedicated Cloud (DeC) users are supported.

Range

N/A
Table 5 storage_type field data structure description

Name

Mandatory

Type

Description

name

Yes

String

Definition

Storage type.

Range

  • ULTRAHIGH: indicates SSD.
  • EXTREMEHIGH indicates ESSD.

az_status

Yes

Map<String,String>

Definition

key indicates the AZ ID, and value indicates the specification status in the AZ.

Range

  • normal: indicates that the specification is on sale.
  • unsupported: The disk type is not supported.
  • sellout: indicates the specifications are sold out.
Table 6 dss_pool_info field data structure description

Name

Mandatory

Type

Description

az_name

Yes

String

Definition

AZ where the dedicated storage pool resides.

Range

N/A

free_capacity_gb

Yes

String

Definition

Indicates the available capacity of DSS. Unit: GB

Range

N/A

dss_pool_volume_type

Yes

String

Definition

Indicates the disk type of DSS storage pool.

Range

N/A

dss_pool_id

Yes

String

Definition

Indicates the DSS pool ID.

Range

N/A

dss_pool_status

Yes

String

Definition

Current status of the dedicated storage pool.

Range

  • available
  • deploying
  • enlarging
  • frozen
  • sellout

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

Example Requests

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/storage-type

Example Responses

{
  "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"
    }
  ]
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: APIs V3.0 (Recommended)