Obtaining Details of a DSS Storage Pool

Updated on 2023-08-07 GMT+08:00

View PDF

Function

This API is used to obtain the details of a specified DSS storage pool.

URI

GET /v1/{project_id}/pools/{dss_id}

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.
dss_id	Yes	String	The storage pool ID.

**Table 2** Request parameter
Parameter	Mandatory	Type	Description
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/{dss_id}?usage=true

Response

Response parameters

Table 3 describes the response parameters.

**Table 3** Response parameters
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 GB.
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

{
   "name" : "dedicatedStorage01",
   "id" : "c950ee97-587c-4f24-8a74-3367e3da570f",
   "project_id" : "63d910f2705a487ebe4e1c274748d9e1",
   "capacity" : 100,
   "type" : "SSD",
   "availability_zone" : "AZ1",
   "status" : "available",
   "created_at" : "2014-12-18T15:57:56.299000",
   "total_capacity_gb": 1000,
   "used_capacity_gb": 300,
   "provisioned_capacity_gb":700,
   "max_over_subscription_ratio": 1.0
}

Error response

{
  "error": {
    "message": "invalid dss id!",
    "code": "DSS.1001"
  }
}

Returned Value

Normal
200
Abnormal
See Error Code Description.

Error Codes

See Error Codes.

Parent topic: API Description

Previous topic: API Description

Next topic: Obtaining Details of DSS Storage Pools

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot