查詢桶容量
更新時間 2024-01-02 11:21:26
最近更新時間: 2024-01-02 11:21:26
分享文章
接口功能介紹
根據指定區域或指定桶查詢存儲容量情況。
接口約束
無
URI
GET /v1/bucket/capacity
路徑參數
無
Query參數
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionCode | 是 | String | 區域編碼。 | 0001 | |
| buckets | 否 | String | 存儲桶名。1. 支持同時查詢多個桶，如果請求中指定桶名查詢，則返回具體存儲桶的存儲容量。2. 不指定則返回該存儲區域的存儲總量。 | buckets=bt1,bt2 | |
| startTime | 是 | Long | 查詢起始時間，時間戳，ms單位。 | 1683684845051 | |
| endTime | 是 | Long | 查詢結束時間，時間戳，ms單位。 | 1683684845051 |
請求參數
請求頭header參數
無
請求body參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 本次請求的結果碼。 | 0 | |
| error | 是 | String | 錯誤碼，創建成功時，不返回該字段。 | ||
| message | 是 | String | 錯誤文本信息，創建成功時，為空字符串。 | ||
| returnObj | 是 | String | 返回結果。 | -- | returnObj |
表 returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回碼。 | 0 | |
| data | 是 | Object | 返回數據。 | storageClass | |
| message | 是 | String | 返回消息。 | OK |
表 storageClass
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| standard | 是 | Array of Objects | 標準存儲分類容量統計值。 | item | |
| standardIA | 是 | Array of Objects | 低頻存儲分類容量統計值。 | item | |
| glacier | 是 | Array of Objects | 歸檔存儲分類容量統計值。 | item |
表 item
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| timestamp | 是 | Long | 分級分類容量統計值時間戳。 | 1586430000000 | |
| value | 是 | Integer | 分類容量統計值，單位byte。 | 24364576 |
請求示例
GET /v1/bucket/capacity?regionCode=0001&buckets=bt1,bt2&startTime=1683684845051&endTime=1683684845051
請求頭header
無
請求體body
無
響應示例
{
"statusCode": "0",
"message": "",
"returnObj": {
"code": "0",
"message": "",
"data": {
"standard": [
{
"timestamp": 1586430000000,
"value": 24364576
}
],
"standardIA": [
{
"timestamp": 1586430000000,
"value": 0
}
],
"glacier": [
{
"timestamp": 1586430000000,
"value": 0
}
]
}
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 0 | 表示業務成功。 |
| 400 | 請求參數有誤。 |
| 403 | 用戶鑒權失敗，用戶無操作權限。 |
| 404 | 請求的資源不存在，輸入作物的URL。 |
| 500 | 業務執行異常。 |
