Querying Storage Pools

Function

This API is used to list storage pools.

This API supports fine-grained permissions for enterprise projects. For details, see ies:storagePool:list.

URI

GET /v1/{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
limit	No	Integer	The number of records on each page.
marker	No	String	Pagination marker.
sort_key	No	Array of strings	Field for sorting.
sort_dir	No	Array of strings	Sorting order. Options: desc: descending order asc: ascending order
edge_site_id	No	String	Edge site ID.

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 StoragePool objects	Storage pool list.
page_info	PageInfo object	Pagination information.

**Table 5** StoragePool
Parameter	Type	Description
id	String	Storage pool ID.
name	String	Storage pool name.
edge_site_id	String	Edge site ID.
storage_type	String	Storage types: SAS: high I/O SSD: ultra-high I/O SAS_SD: high I/O (software-defined) SSD_SD: ultra-high I/O (software-defined) SAS_ARM: high I/O (Kunpeng) SSD_ARM: ultra-high I/O (Kunpeng) VS_SMALL_CAP: edge object storage (small-capacity) VS_MEDIUM_CAP: edge object storage (medium-capacity) VS_LARGE_CAP: edge object storage (large-capacity) CBR_STANDARD_SMALL_CAP: Cloud Backup and Recovery (basic edition) (small-capacity) CBR_STANDARD_MEDIUM_CAP: Cloud Backup and Recovery (basic edition) (medium-capacity) CBR_STANDARD_LARGE_CAP: Cloud Backup and Recovery (basic edition) (large-capacity) CBR_PROFESSIONAL_SMALL_CAP: Cloud Backup and Recovery (professional edition) (small-capacity) CBR_PROFESSIONAL_MEDIUM_CAP: Cloud Backup and Recovery (professional edition) (medium-capacity) CBR_PROFESSIONAL_LARGE_CAP: Cloud Backup and Recovery (professional edition) (large-capacity)
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.
resource_spec_code	String	Resource specification code.
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.
effected_at	String	Effective time.

**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}/v1/{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,
    "resource_spec_code" : "ies.blockstorage.gear1",
    "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"
      }
    },
    "created_at" : "2022-01-18T02:56:02.76091Z",
    "updated_at" : "2022-01-18T02:59:56.5601Z",
    "effected_at" : "2022-01-19T02:59:25Z"
  } ],
  "page_info" : {
    "current_count" : 1
  }
}