Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Storage Management/ Querying the Disk Type of a DB Instance
Updated on 2025-08-18 GMT+08:00
View PDF

Querying the Disk Type of a DB Instance

Function

This API is used to query the disk type of a DB instance. Before calling this API:

URI

GET https://{Endpoint}/v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode}
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

version

Yes

String

Explanation:

DB version number. To obtain the DB version number, see Querying DB Engine Versions.

Value range:

None

ha_mode

No

String

Explanation:

Instance mode.

The value is case-insensitive.

Values:

  • enterprise (distributed)
  • centralization_standard (centralized)

Request Parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

storage_type

Array of objects

Explanation:

Storage type information.

For details, see Table 3.
Table 3 storage_type field data structure description

Parameter

Type

Description

name

String

Explanation: disk type name.

Values:

  • ULTRAHIGH: indicates the SSD.

az_status

map<String, String>

Explanation:

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

Values:

  • normal: on sale.
  • unsupported: not supported.
  • sellout: sold out.

support_compute_group_type

List<String>

Explanation:

Performance specifications.

Values:

  • normal: general-enhanced
  • normal2: general-enhanced II
  • armFlavors: Kunpeng general computing-plus

Example Request

  • Querying the disk type of a distributed instance 
    GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/storage-type?version=2.1&ha_mode=enterprise
  • Querying the disk type of a centralized instance 
    https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/storage-type?version=2.1&ha_mode=centralization_standard

Example Response

Disk types of the instances queried.

	
{
    "storage_type": [
        {
            "name": "ULTRAHIGH",
            "az_status": {
            },
            "support_compute_group_type": [
                "normal",
                "armFlavors",
                "normal2"
            ]
        }
    ]
}

Status Code

Error Codes

For details, see Error Codes.

Parent topic: Storage Management