文档首页/ 专属分布式存储服务 DSS/ API参考/ API说明/ 获取专属分布式存储池详情列表
更新时间：2023-08-04 GMT+08:00
查看PDF
分享

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

功能介绍

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

调试

您可以在API Explorer中直接运行调试该接口。

URI

GET /v1/{project_id}/pools/detail

参数说明请参见表1。
表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

项目ID。

获取方法请参考获取项目ID。
表2 请求参数

名称

是否必选

参数类型

说明

limit

否

Integer

分页查询返回结果个数限制，取值为大于0的整数。

offset

否

Integer

分页查询起始地址，必须是正整数或0。

说明：

分页查询偏移量，表示查询该偏移量后面所有的存储池。

status

否

String

专属分布式存储池的状态，例如available, deploying和extending，详细信息请参考专属分布式存储池状态。

name

否

String

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

usage

否

Boolean

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

请求消息

请求样例

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

响应消息

响应参数

响应参数如表3所示。
表3 响应参数

名称

参数类型

说明

pools

Array of objects

专属分布式存储池详情列表，详细参数说明请参见表4。

count

Integer

专属分布式存储池个数。
返回的存储池详情数据结构
表4 参数说明

名称

参数类型

说明

name

String

专属分布式存储池名称。

id

String

专属分布式存储池ID。

project_id

String

专属分布式存储池归属的project_id。

capacity

Integer

申请的专属分布式存储容量，单位TB。

type

String

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

  • SAS：高IO专属分布式存储池。
  • SSD：超高IO专属分布式存储池。

status

String

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

availability_zone

String

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

created_at

String

专属分布式存储池的创建时间。

时间格式：UTC YYYY-MM-DDTHH:MM:SS

total_capacity_gb

Integer

总容量（GB）（专属分布式存储池状态为deploying时，无该字段）。

used_capacity_gb

Integer

已使用容量（GB）（专属分布式存储池状态为deploying时，无该字段）。

provisioned_capacity_gb

Integer

已分配容量（GB）（专属分布式存储池状态为deploying时，无该字段）。

max_over_subscription_ratio

Float

超分比（专属分布式存储池状态为deploying时，无该字段）。
  • 响应样例 
    {
     "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": {
    "message": "invalid filter limit!",
    "code": "DSS.1003"
  }
}

返回值

错误码

请参考错误码。

父主题： API说明

相关文档