功能介紹
獲取租戶申請(qǐng)的 專(zhuān)屬分布式存儲(chǔ) 池詳情列表,支持過(guò)濾查詢和分頁(yè)查詢。
調(diào)試
您可以在API Explorer中直接運(yùn)行調(diào)試該接口。
URI
GET /v1/{project_id}/pools/detail
名稱 |
是否必選 |
參數(shù)類(lèi)型 |
說(shuō)明 |
---|---|---|---|
project_id |
是 |
String |
項(xiàng)目ID。 獲取方法請(qǐng)參考獲取項(xiàng)目ID。 |
名稱 |
是否必選 |
參數(shù)類(lèi)型 |
說(shuō)明 |
---|---|---|---|
limit |
否 |
Integer |
分頁(yè)查詢返回結(jié)果個(gè)數(shù)限制,取值為大于0的整數(shù)。 |
offset |
否 |
Integer |
分頁(yè)查詢起始地址,必須是正整數(shù)或0。 說(shuō)明:
分頁(yè)查詢偏移量,表示查詢?cè)撈屏亢竺嫠械拇鎯?chǔ)池。 |
status |
否 |
String |
專(zhuān)屬分布式存儲(chǔ)池的狀態(tài),例如available, deploying和extending,詳細(xì)信息請(qǐng)參考專(zhuān)屬分布式存儲(chǔ)池狀態(tài)。 |
name |
否 |
String |
專(zhuān)屬分布式存儲(chǔ)池的名稱。 |
usage |
否 |
Boolean |
當(dāng)usage=true時(shí),返回值帶有專(zhuān)屬分布式存儲(chǔ)池容量信息,默認(rèn)為false。 |
請(qǐng)求消息
請(qǐng)求樣例
GET https://{endpoint}/v1/{project_id}/pools/detail?status=available&usage=true
響應(yīng)消息
響應(yīng)參數(shù)
名稱 |
參數(shù)類(lèi)型 |
說(shuō)明 |
---|---|---|
name |
String |
專(zhuān)屬分布式存儲(chǔ)池名稱。 |
id |
String |
專(zhuān)屬分布式存儲(chǔ)池ID。 |
project_id |
String |
專(zhuān)屬分布式存儲(chǔ)池歸屬的project_id。 |
capacity |
Integer |
申請(qǐng)的專(zhuān)屬分布式存儲(chǔ)容量,單位TB。 |
type |
String |
專(zhuān)屬分布式存儲(chǔ)池的存儲(chǔ)類(lèi)型。
|
status |
String |
專(zhuān)屬分布式存儲(chǔ)池的狀態(tài),詳細(xì)信息請(qǐng)參考專(zhuān)屬分布式存儲(chǔ)池狀態(tài)。 |
availability_zone |
String |
專(zhuān)屬分布式存儲(chǔ)池所屬AZ。 |
created_at |
String |
專(zhuān)屬分布式存儲(chǔ)池的創(chuàng)建時(shí)間。 時(shí)間格式:UTC YYYY-MM-DDTHH:MM:SS |
total_capacity_gb |
Integer |
總?cè)萘浚℅B)(專(zhuān)屬分布式存儲(chǔ)池狀態(tài)為deploying時(shí),無(wú)該字段)。 |
used_capacity_gb |
Integer |
已使用容量(GB)(專(zhuān)屬分布式存儲(chǔ)池狀態(tài)為deploying時(shí),無(wú)該字段)。 |
provisioned_capacity_gb |
Integer |
已分配容量(GB)(專(zhuān)屬分布式存儲(chǔ)池狀態(tài)為deploying時(shí),無(wú)該字段)。 |
max_over_subscription_ratio |
Float |
超分比(專(zhuān)屬分布式存儲(chǔ)池狀態(tài)為deploying時(shí),無(wú)該字段)。 |
- 響應(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)用異常時(shí),錯(cuò)誤響應(yīng)樣例
{ "error": { "message": "invalid filter limit!", "code": "DSS.1003" } }
返回值
- 正常
- 異常
請(qǐng)參考錯(cuò)誤碼。
錯(cuò)誤碼
請(qǐng)參考錯(cuò)誤碼。