Obtaining Details of a DSS Storage Pool

Function

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID. For details, see Obtaining a Project ID.
dss_id	Yes	String	The storage pool ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
usage	No	Boolean	Whether capacity information of the storage pool is returned. The value can be true (returns capacity information) or false (does not return capacity information). The default value is false.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
name	String	The storage pool name.
id	String	The storage pool ID.
project_id	String	The ID of the belonging project.
capacity	Integer	The requested storage pool capacity, in GB.
type	String	The storage pool type. 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.
total_capacity_gb	Integer	The total capacity.
used_capacity_gb	Integer	The used capacity.
provisioned_capacity_gb	Integer	The allocated capacity.
max_over_subscription_ratio	Float	The overcommitment ratio.

Example Requests

GET https://{endpoint}/v1/{project_id}/pools/{dss_id}?usage=ture

Example Responses

Status code: 200

Details of storage pools

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

SDK Sample Code

The SDK sample code is as follows.

Java

     package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dss.v1.region.DssRegion;
import com.huaweicloud.sdk.dss.v1.*;
import com.huaweicloud.sdk.dss.v1.model.*;


public class ShowPoolSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DssClient client = DssClient.newBuilder()
                .withCredential(auth)
                .withRegion(DssRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowPoolRequest request = new ShowPoolRequest();
        request.withDssId("{dss_id}");
        try {
            ShowPoolResponse response = client.showPool(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 
 
  

Python

     # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdss.v1.region.dss_region import DssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdss.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowPoolRequest()
        request.dss_id = "{dss_id}"
        response = client.show_pool(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 
 
  

Go

     package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dss/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dss/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dss/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dss.DssClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dss.NewDssClient(hcClient)

    request := &model.ShowPoolRequest{}
	request.DssId = "{dss_id}"
	response, err := client.ShowPool(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
 
 
  