Help Center/ CloudPond/ API Reference/ API/ Storage Billing Tiers/ Querying Storage Billing Tiers

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

View PDF

Querying Storage Billing Tiers

Function

This API returns only the supported storage billing tiers. You can specify the actual storage capacity.

URI

GET /v2/{domain_id}/storage-gears

**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.
pay_mode	No	Array of strings	Billing mode.
period_num	No	Array of integers	Purchase duration.
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_gears	Array of StorageGearV2 objects	List of supported storage tiers.
page_info	PageInfo object	Pagination information.

**Table 5** StorageGearV2
Parameter	Type	Description
id	String	Storage tier ID.
gear	Integer	Storage tier, for example, 35 TB.
storage_type	String	Storage type (SAS: high I/O; SSD: ultra-high I/O).
product_info	ProductInfo object	Attribute information about the product to which the offering belongs.
zone_code	String	Deployment area.
sale_cycles	Array of SaleCycle objects	Objects of the sales cycle.

**Table 6** ProductInfo
Parameter	Type	Description
cloud_service_type	String	Cloud service type.
resource_type	String	Resource type.
resource_spec_code	String	Resource code.

**Table 7** SaleCycle
Parameter	Type	Description
pay_mode	String	Yearly/monthly payment type. Options: FULL: All upfront payments HALF: Half upfront payments PAID_BY_YEAR: Yearly payments ZERO_PAID_BY_YEAR: Yearly payments without upfront
period_type	String	Subscription period type. year: Yearly
period_num	Integer	The number of subscription periods.

**Table 8** 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 billing tiers

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

Example Response

Status code: 200

successful operation

{
  "storage_gears" : [ {
    "id" : "00000000-0000-000-0000-000000000000",
    "gear" : 35,
    "storage_type" : "SAS",
    "product_info" : {
      "cloud_service_type" : "hws.service.type.ies",
      "resource_type" : "hws.resource.type.iesvolume",
      "resource_spec_code" : "ies.blockstorage.gear1"
    },
    "zone_code" : "CN",
    "sale_cycles" : [ {
      "pay_mode" : "FULL",
      "period_type" : "year",
      "period_num" : 3
    } ]
  } ],
  "page_info" : {
    "current_count" : 1
  }
}