Help Center> Relational Database Service> API Reference> API v3 (Recommended)> Querying the Storage Type of a Database

Querying the Storage Type of a Database

Function

This API is used to query the storage type of a specified DB engine version.

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/storage-type/{database_name}?version_name={version_name}&ha_mode={ha_mode}

  • Example

    https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/storage-type/mysql?version_name=5.7&ha_mode=ha

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    database_name

    Yes

    Specifies the DB engine name. Its value can be any of the following and is case-insensitive:

    • MySQL
    • PostgreSQL
    • SQLServer

    version_name

    Yes

    Specifies the database version. For details about how to obtain the database version, see section Querying Version Information About a DB Engine.

    ha_mode

    No

    Specifies the HA mode. The value options are as follows:

    • single
    • ha
    • replica

Request

None

Response

  • Normal response
    Table 2 Parameter description

    Name

    Type

    Description

    storage_type

    Array of objects

    Indicates the DB instance specifications information list.

    For details, see Table 3.

    dsspool_info

    Array of objects

    Indicates the dsspool specifications information list.

    For details, see Table 4.

    NOTE:

    Only Dedicated Cloud (DeC) users are supported.

    Table 3 storage_type field data structure description

    Name

    Type

    Description

    name

    String

    Indicates the storage type. Its value can be any of the following:

    • ULTRAHIGH: indicates the SSD type.
    • LOCALSSD: indicates the local SSD.

    az_status

    Map<String, String>

    Indicates the status of the AZ to which the DB instance specifications belong. Its value can be any of the following:

    • normal: indicates that the AZ is on sale.
    • unsupported: indicates that the DB instance specifications are not supported by the AZ.
    • sellout: indicates that the DB instance specifications are sold out.
    Table 4 dsspool_info field data structure description

    Name

    Type

    Description

    az_name

    String

    Indicates the name of the AZ where dsspool is located.

    free_capacity_gb

    String

    Indicates the available capacity of dsspool.

    dsspool_volume_type

    String

    Indicates the dsspool volume type.

    dsspool_id

    String

    Indicates the dsspool ID.

    dsspool_status

    String

    Indicates the dsspool status. Its value can be any of the following:

    • available
    • deploying
    • enlarging
    • frozen
    • sellout
  • Example normal response
    {
    	"storage_type": [{
    			"name": "COMMON",
    			"az_status": {
    				"az1": "normal",
    				"az2": "normal"
    			}
    		},
    		{
    			"name": "ULTRAHIGH",
    			"az_status": {
    				"az1": "normal",
    				"az2": "normal"
    			}
    		}
    	]
    }

    DeC user query response example

    {
    	"storage_type": [
    		{
    			"name": "COMMON",
    			"az_status": {
    				"az1xahz": "normal",
    				"az3xahz": "normal"
    			}
    		},
    		{
    			"name": "ULTRAHIGH",
    			"az_status": {
    				"az1xahz": "normal",
    				"az3xahz": "normal"
    			}
    		}
    	],
    	"dsspool_info": [
    		{
    			"az_name": "az1xahz",
    			"free_capacity_gb": "8656",
    			"dsspool_volume_type": "ULTRAHIGH",
    			"dsspool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
    			"dsspool_status": "available"
    		}
    	]
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.