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

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

View PDF

Querying Storage Pools

Function

This API is used to list storage pools.

URI

GET /v2/{domain_id}/storage-pools

**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
edge_site_id	No	String	Edge site ID.
limit	No	Integer	The number of records on each page.
marker	No	String	Pagination marker.
status	No	Array of strings	The status specified for querying storage pools. Multiple values are supported for query.

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_pools	Array of StoragePoolV2 objects	Storage pool list.
page_info	PageInfo object	Pagination information.

**Table 5** StoragePoolV2
Parameter	Type	Description
id	String	Storage pool ID.
name	String	Storage pool name.
edge_site_id	String	Edge site ID.
storage_type	String	Storage type.
status	String	The storage pool status. Options: CREATING: Creating AVAILABLE: Available EXPANDING: Expanding PENDING_PAYMENT: Pending payment FROZEN: Frozen
assigned_size	Integer	Storage pool size. Purchased storage capacity.
product_info	ProductInfo object	Attribute information about the product to which the offering belongs.
capacity	Integer	Total capacity.
market_options	MarketOptions object	Billing information.
created_at	String	Creation time.
updated_at	String	Update time.
parent_id	String	ID of the pre-generated storage pool in the capacity expansion scenario.

**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** MarketOptions
Parameter	Type	Description
charge_mode	String	Billing mode. prepaid: Yearly/monthly
prepaid_options	PrepaidOptions object	Yearly/Monthly billing information.
strategies	Array of Strategy objects	The list of sales strategies.

**Table 8** PrepaidOptions
Parameter	Type	Description
order_id	String	Order ID.
product_id	String	Product ID.
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

**Table 9** Strategy
Parameter	Type	Description
status	String	O&M status. FREEZE: Frozen
scene	String	Resource operating status. Options: ARREAR: Resources are in arrears. POLICE: Resources are frozen for public security. ILLEGAL: Resources are frozen due to violation of laws and regulations. VERIFY: Resources are frozen because the user fails to pass real-name authentication.
effect	String	Resource operations: DELETABLE: Resources can be deleted. UNDELETABLE: Resources cannot be deleted.

**Table 10** 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 pools

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

Example Response

Status code: 200

successful operation

{
  "storage_pools" : [ {
    "id" : "d70a8f73-edef-4b71-beb3-7dbc22f0365e",
    "name" : "SAS-ojoiv",
    "edge_site_id" : "a4a36874-c41b-4295-9fd5-6823864fd564",
    "storage_type" : "SAS",
    "status" : "AVAILABLE",
    "assigned_size" : 36,
    "product_info" : {
      "cloud_service_type" : "hws.service.type.ies",
      "resource_type" : "hws.resource.type.iesvolume",
      "resource_spec_code" : "ies.blockstorage.gear1"
    },
    "capacity" : 144,
    "market_options" : {
      "charge_mode" : "prepaid",
      "prepaid_options" : {
        "order_id" : "CS2201181056V3SK6",
        "product_id" : "OFFI644832402269233154",
        "pay_mode" : "FULL"
      }
    }
  } ],
  "page_info" : {
    "current_count" : 1
  }
}