Updated on 2024-04-11 GMT+08:00

Querying the Storage Type of a Database

Function

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

  • Before calling an API, you need to understand the API in Authentication.

URI

  • URI format

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

  • Example

    https://{Endpoint}/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

    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.

    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: SSD storage (ultra-high I/O).
    • CLOUDSSD: cloud SSD storage.

    az_status

    Map<String, String>

    Indicates the specification status in an AZ. Its value can be any of the following:

    • normal: indicates that the specifications in the AZ are available.
    • unsupported: indicates that the specifications are not supported by the AZ.
    • sellout: indicates that the specifications in the AZ are sold out.
  • Example normal response
    {
    	"storage_type": [{
    			"name": "CLOUDSSD",
    			"az_status": {
    				"az1": "normal",
    				"az2": "normal",
    			}
    		}
    	]
            "dsspool_info": []
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.