文档首页/ 专属分布式存储服务 DSS/ API参考/ API说明/ DSS管理/ 获取专属存储详情列表 - ListPools
更新时间:2025-11-24 GMT+08:00
分享

获取专属存储详情列表 - ListPools

功能介绍

获取租户申请的专属分布式存储池详情列表,支持过滤查询和分页查询。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v1/{project_id}/pools/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

返回结果个数限制。

最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。

offset

Integer

分页查询起始地址,必须是正整数或0(页查询偏移量,表示查询该偏移量后面所有的存储池)。

status

String

存储池的状态,例如available, deploying和extending。

name

String

专属分布式存储池的名称。

usage

Boolean

当usage=true时,返回值带有专属分布式存储池容量信息,默认为false。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

专属分布式存储池个数。

pools

Array of PoolDetails objects

专属分布式存储池详情列表。

表5 PoolDetails

参数

参数类型

描述

name

String

专属分布式存储池名称。

id

String

专属分布式存储池ID。

project_id

String

所属的项目ID。

capacity

Integer

申请的专属分布式存储池容量,单位GB。

type

String

专属分布式存储池的存储类型。

SAS:高IO专属分布式存储池。

SSD:超高IO专属分布式存储池。

status

String

专属分布式存储池的状态,详细信息请参考专属分布式存储池状态

availability_zone

String

专属分布式存储池所在AZ。

created_at

String

创建时间。

total_capacity_gb

Integer

总容量。

used_capacity_gb

Integer

已使用容量。

provisioned_capacity_gb

Integer

已分配容量。

max_over_subscription_ratio

Float

超分比。

请求示例

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

响应示例

状态码:200

存储池详情列表

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

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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 ListPoolsSolution {

    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();
        ListPoolsRequest request = new ListPoolsRequest();
        try {
            ListPoolsResponse response = client.listPools(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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# 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 = ListPoolsRequest()
        response = client.list_pools(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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dss.NewDssClient(
        dss.DssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

存储池详情列表

错误码

请参见错误码

相关文档