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

Updated on 2025-12-08 GMT+08:00

View PDF

Querying Storage Pools

Function

This API is used to list storage pools.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ies:edgeSite:listStoragePools	List	edgeSite *	g:EnterpriseProjectId	ies:storagePool:list	-

URI

GET /v2/{domain_id}/storage-pools

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the path.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
edge_site_id	No	String	Edge site ID
delivery_order_id	No	String	Delivery Order ID
limit	No	Integer	Page size.
marker	No	String	Pagination identifier.
status	No	Array of strings	Storage pools queried by status. Multiple values are supported for query.

Request Parameters

**Table 3** Request header parameters
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	Storage pool statuses: CREATING: creating AVAILABLE: available EXPANDING: being expanded PENDING_PAYMENT: Pending payment FROZEN: frozen
assigned_size	Integer	Storage pool size. The size is the storage capacity that has been purchased.
product_info	ProductInfo object	Attribute information about the product to which the offering belongs.
capacity	Integer	Total capacity.
market_options	MarketOptions object	Billing
created_at	String	Creation time.
updated_at	String	Update time.
parent_id	String	ID of the storage pool associated with 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.
strategies	Array of Strategy objects	The list of sales policies.

**Table 8** PrepaidOptions
Parameter	Type	Description
order_id	String	Order ID
product_id	String	Product ID
pay_mode	String	Yearly/Monthly payment. FULL: full upfront HALF: half upfront PAID_BY_YEAR: Yearly ZERO_PAID_BY_YEAR: zero upfront, yearly

**Table 9** Strategy
Parameter	Type	Description
status	String	O&M status: FREEZE: frozen
scene	String	Resource operations status: ARREAR: The account is in arrears. POLICE: public security. ILLEGAL: violation scenario. VERIFY: The resource is frozen because the user fails to pass the real-name authentication.
effect	String	Resource operations: DELETABLE: deletable UNDELETABLE: unable to delete

**Table 10** PageInfo
Parameter	Type	Description
next_marker	String	Next page marker.
current_count	Integer	Number of records on the current page.

Example Requests

Example request for querying storage pools

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

Example Responses

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
  }
}