Querying the Database Disk Type

API Description

URI

• URI format

  GET https://{Endpoint}/v3/{project_id}/storage-type?engine_name={engine_name}

Requests

Request parameters

Responses

• Parameter description

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  storage_type	Array of objects	Yes	Indicates the database disk information list. For more information, see Table 3.
  dss_pool_info	Array of objects	Yes	Indicates the dss_pool specifications information list. For more information, see Table 4. NOTE: Only Dedicated Cloud (DeC) users are supported.

  Table 3 storage_type field data structure description

  Name	Type	Mandatory	Description
  name	String	Yes	Indicates the storage type. Its value can be: ULTRAHIGH: indicates the SSD type. EXTREMEHIGH indicates ESSD.
  az_status	Map<String,String>	Yes	key indicates the AZ ID, and value indicates the specification status in the AZ. Its value can be any of the following: normal: indicates that the specifications are on sale. unsupported: The disk type is not supported. sellout: indicates the specifications are sold out.

  Table 4 dss_pool_info field data structure description

  Name	Type	Mandatory	Description
  az_name	String	Yes	Indicates the name of the AZ where the dss_pool is located.
  free_capacity_gb	String	Yes	Indicates the available capacity of DSS. Unit: GB
  dss_pool_volume_type	String	Yes	Indicates the disk type of DSS storage pool.
  dss_pool_id	String	Yes	Indicates the DSS pool ID.
  dss_pool_status	String	Yes	Indicates the dss_pool status. Its value can be any of the following: available deploying enlarging

  Note

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

• Response example

  {
    "storage_type": [
      {
        "name": "ULTRAHIGH",
        "az_status": {
          "az1": "normal",
          "az2": "normal",
          "az3": "unsupported"
        }
      }
    ],
   
  }
  
  

Status Code

Error Code