華為云計算 云知識 獲取專屬存儲詳情列表ListPools
獲取專屬存儲詳情列表ListPools

 

功能介紹

獲取租戶申請的 專屬分布式存儲 池詳情列表,支持過濾查詢和分頁查詢。

調(diào)試

您可以在API Explorer中直接運行調(diào)試該接口。

URI

GET /v1/{project_id}/pools/detail

參數(shù)說明請參見表1。
表1 參數(shù)說明

名稱

是否必選

參數(shù)類型

說明

project_id

String

項目ID。

獲取方法請參考獲取項目ID

表2 請求參數(shù)

名稱

是否必選

參數(shù)類型

說明

limit

Integer

分頁查詢返回結(jié)果個數(shù)限制,取值為大于0的整數(shù)。

offset

Integer

分頁查詢起始地址,必須是正整數(shù)或0。

說明:

分頁查詢偏移量,表示查詢該偏移量后面所有的存儲池。

status

String

專屬分布式存儲池的狀態(tài),例如available, deploying和extending,詳細(xì)信息請參考專屬分布式存儲池狀態(tài)

name

String

專屬分布式存儲池的名稱。

usage

Boolean

當(dāng)usage=true時,返回值帶有專屬分布式存儲池容量信息,默認(rèn)為false。

請求消息

請求樣例

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

響應(yīng)消息

響應(yīng)參數(shù)

響應(yīng)參數(shù)如表3所示。
表3 響應(yīng)參數(shù)

名稱

參數(shù)類型

說明

pools

Array of objects

專屬分布式存儲池詳情列表,詳細(xì)參數(shù)說明請參見表4。

count

Integer

專屬分布式存儲池個數(shù)。

返回的存儲池詳情數(shù)據(jù)結(jié)構(gòu)
表4 參數(shù)說明

名稱

參數(shù)類型

說明

name

String

專屬分布式存儲池名稱。

id

String

專屬分布式存儲池ID。

project_id

String

專屬分布式存儲池歸屬的project_id。

capacity

Integer

申請的專屬分布式存儲容量,單位TB。

type

String

專屬分布式存儲池的存儲類型。

  • SAS:高IO專屬分布式存儲池。
  • SSD:超高IO專屬分布式存儲池。

status

String

專屬分布式存儲池的狀態(tài),詳細(xì)信息請參考專屬分布式存儲池狀態(tài)。

availability_zone

String

專屬分布式存儲池所屬AZ。

created_at

String

專屬分布式存儲池的創(chuàng)建時間。

時間格式:UTC YYYY-MM-DDTHH:MM:SS

total_capacity_gb

Integer

總?cè)萘浚℅B)(專屬分布式存儲池狀態(tài)為deploying時,無該字段)。

used_capacity_gb

Integer

已使用容量(GB)(專屬分布式存儲池狀態(tài)為deploying時,無該字段)。

provisioned_capacity_gb

Integer

已分配容量(GB)(專屬分布式存儲池狀態(tài)為deploying時,無該字段)。

max_over_subscription_ratio

Float

超分比(專屬分布式存儲池狀態(tài)為deploying時,無該字段)。

  • 響應(yīng)樣例
    {
         "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
    }
  • 接口調(diào)用異常時,錯誤響應(yīng)樣例
    {
      "error": {
        "message": "invalid filter limit!",
        "code": "DSS.1003"
      }
    }

返回值

錯誤碼

請參考錯誤碼。