Help Center/ CloudPond/ API Reference/ API/ Storage Types/ Querying Storage Types

Updated on 2025-10-28 GMT+08:00

View PDF

Querying Storage Types

Function

This API is used to query the supported storage types, including purchase increments.

URI

GET /v2/{domain_id}/storage-types

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the URI.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
zone_code	No	String	Area code.
name	No	String	Storage types.
limit	No	Integer	The number of records on each page.
marker	No	String	Pagination marker.

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
storage_types	Array of StorageTypeOption objects	Storage type list.
page_info	PageInfo object	Pagination information.

**Table 5** StorageTypeOption
Parameter	Type	Description
id	String	Storage type ID. The value is in UUID format.
name	String	The storage type for sale.
zone_code	String	Area code, which indicates that devices can be purchased and deployed in this area.
expand_capacity_step	Integer	Purchase increments. If the value is 0, only the capacity in gears can be purchased.
supported_capacities	Array of integers	Fixed purchase capacity. If this parameter is left blank, the capacity is purchased by purchase increment.

**Table 6** PageInfo
Parameter	Type	Description
next_marker	String	Marker of the next page.
current_count	Integer	The number of records on the current page.

Example Request

Querying storage types

GET https://{ies_endpoint}/v2/{domain_id}/storage-types

Example Response

Status code: 200

successful operation

{
  "storage_types" : [ {
    "id" : "00000000-0000-000-0000-000000000000",
    "name" : "SAS",
    "zone_code" : "CN",
    "expand_capacity_step" : 20,
    "supported_capacities" : [ 35, 70, 140 ]
  } ],
  "page_info" : {
    "current_count" : 1
  }
}