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

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 /v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode}
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

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

Default Value

N/A

version

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

ha_mode

No

String

Definition

Instance mode.

The value is case-insensitive.

Constraints

N/A

Range

  • enterprise (distributed)
  • centralization_standard (centralized)

Default Value

N/A

Request Parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

storage_type

Array of objects

Definition

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.

Range

  • ULTRAHIGH: indicates the SSD.
  • ESSD: indicates the extreme SSD.

az_status

map<String, String>

Definition

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

Range

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

support_compute_group_type

List<String>

Definition

Performance specifications.

Range

  • normal: dedicated (1:8)
  • normal2: dedicated (1:4)
  • armFlavors: Kunpeng dedicated (1:8)
  • armFlavors2: Kunpeng dedicated (1:4)
  • armFlavors2Shared: Kunpeng general computing-plus II (shared)
  • general: general-purpose (1:4)
  • exclusive: dedicated (1:4). It is only suitable for centralized instances of the basic edition.
  • armExclusive: Kunpeng dedicated (1:4). It is only suitable for centralized instances of the basic edition.
  • economical: favored (1:4)
  • economical2: favored (1:8)

Example Request

  • Querying the disk type of a distributed instance
    GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/storage-type?version=2.1&ha_mode=enterprise
  • Querying the disk type of a centralized instance
    https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/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": {
                "aaa": "normal",
                "bbb": "normal",
                "ccc": "normal"
            },
            "support_compute_group_type": [
                "normal",
                "armFlavors",
                "armFlavors2Shared",
                "normal2"
            ]
        },
        {
            "name": "ESSD",
            "az_status": {
                "az2xahz": "normal",
                "az1xahz": "normal",
                "az3xahz": "normal"
            },
            "support_compute_group_type": [
                "normal",
                "armFlavors",
                "armFlavors2Shared",
                "normal2"
            ]
        }
    ]
}

Status Code

Error Codes

For details, see Error Codes.