Help Center/ Dedicated Distributed Storage Service/ API Reference/ API Description/ Obtaining Details of DSS Storage Pools
Updated on 2023-08-07 GMT+08:00
View PDF
Share

Obtaining Details of DSS Storage Pools

Function

This API is used to obtain the DSS storage pools requested by a tenant. Filter query and pagination query are supported.

URI

GET /v1/{project_id}/pools/detail

Table 1 describes the parameters.
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

For how to obtain the project ID, see Obtaining a Project ID.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The maximum number of query results that can be returned. The value must be an integer greater than 0.

offset

No

Integer

The start position of a pagination query. The value must be a positive integer or 0.

NOTE:

This parameter indicates that all storage pools after this pagination query offset are queried.

status

No

String

The storage pool status. The value can be available, deploying, or extending. For details, see DSS Storage Pool Status.

name

No

String

The storage pool name.

usage

No

Boolean

Whether the storage pool capacity information is returned. The value can be true or false. Value true indicates to return the capacity information. The default value is false.

Request

Example request

GET https://{endpoint}/v1/{project_id}/pools/detail?status=available&usage=true

Response

Response parameters

Table 3 describes the response parameters.
Table 3 Response parameters

Parameter

Type

Description

pools

Array of objects

The storage pool details. For details, see Table 4.

count

Integer

The number of storage pools.
Description of returned storage pool parameters
Table 4 Parameter description

Parameter

Type

Description

name

String

The storage pool name.

id

String

The storage pool ID.

project_id

String

The ID of the project that the pool belongs.

capacity

Integer

The requested storage pool capacity, in TB.

type

String

The storage pool type. The value can be as follows:

  • SAS: high I/O storage pool
  • SSD: ultra-high I/O storage pool

status

String

The storage pool status. For details, see DSS Storage Pool Status.

availability_zone

String

The AZ where the storage pool resides.

created_at

String

The time when the storage pool was created.

Time format: UTC YYYY-MM-DDTHH:MM:SS

total_capacity_gb

Integer

The total capacity of the storage pool, in GB. (This parameter is not returned if the storage pool status is deploying.)

used_capacity_gb

Integer

The used capacity of the storage pool, in GB. (This parameter is not returned if the storage pool status is deploying.)

provisioned_capacity_gb

Integer

The allocated capacity of the storage pool, in GB. (This parameter is not returned if the storage pool status is deploying.)

max_over_subscription_ratio

Float

The overcommitment ratio of the storage pool. (This parameter is not returned if the storage pool status is deploying.)
  • Example response 
    {
     "pools" : [ {
     "name" : "dedicatedStorage01",
     "id" : "c950ee97-587c-4f24-8a74-3367e3da570f",
     "project_id" : "63d910f2705a487ebe4e1c274748d9e1",
     "capacity" : 1000,
     "type" : "SSD",
     "availability_zone" : "AZ1",
     "status" : "available",
     "created_at" : "2014-12-18T15:57:56.299000",
     "total_capacity_gb": 850,
     "used_capacity_gb": 300,
     "provisioned_capacity_gb":700,
     "max_over_subscription_ratio": 1.0
     }, 
{
     "name" : "dedicatedStorage02",
     "id" : "6edbc2f4-1507-44f8-ac0d-eed1d2608d38",
     "project_id" : "63d910f2705a487ebe4e1c274748d9e1",
     "capacity" : 1000,
     "type" : "SSD",
     "availability_zone" : "AZ1",
     "status" : "available",
     "created_at" : "2014-12-18T15:57:56.299000",
     "total_capacity_gb": 850,
     "used_capacity_gb": 300,
     "provisioned_capacity_gb":700,
     "max_over_subscription_ratio": 1.0
  } ] ,
    "count": 2
}
  • Error response 
    {
  "error": {
    "message": "invalid filter limit!",
    "code": "DSS.1003"
  }
}

Returned Value

Error Codes

See Error Codes.

Parent topic: API Description