Function

This API is used to query the database disk type in the current region.

URI

• URI format

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

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.
  engine_name	No	Specifies the database type. The value is DDS-Community.

Requests

• Request header

  GET https://DDS Endpoint/v3/375d8d8fad1f43039e23d3b6c0f60a19/storage-type?engine_name=DDS-Community

• Request body

  N/A

Responses

• Parameter description

  Table 2 Parameter description

  Name	Type	Description
  storage_type	Array of objects	Indicates the database disk information list. For more information, see Table 3.
  dss_pool_info	Array of objects	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	Description
  name	String	Indicates the storage type. Its value can be: ULTRAHIGH: indicates the SSD type.
  az_status	Object	Indicates the status of specifications in an 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	Description
  az_name	String	Indicates the name of the AZ where the dss_pool is located.
  free_capacity_gb	String	Indicates the available capacity of DSS. Unit: GB
  dss_pool_volume_type	String	Indicates the disk type of DSS storage pool.
  dss_pool_id	String	Specifies the DSS storage pool ID.
  dss_pool_status	String	Indicates the dss_pool status. Its value can be any of the following: available deploying enlarging frozen sellout

  

  The value of az_status is used as an example.

• Response example

  {
  "storage_type": [
  {
  "name": "ULTRAHIGH",
  "az_status": {
  "cn-north-1a": "normal",
  "cn-north-1b": "normal",
  "cn-north-1c": "unsupported"
  }
  }
  ],
  "dsspool_info": []
  }

• DeC user query response example

  {
  "storage_type": [
  {
  "name": "ULTRAHIGH",
  "az_status": {
  "cn-north-1a": "normal",
  "cn-north-1b": "normal",
  "cn-north-1c": "unsupported"
  }
  }
  ],
  "dss_pool_info":[
  {
  "az_name": "cn-north-1a",
  "free_capacity_gb": "8656",
  "dss_pool_volume_type": "ULTRAHIGH",
  "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
  "dss_pool_status": "available"
  }
  ]
  }

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.