獲取桶清單規則
更新時間 2023-12-14 17:42:20
最近更新時間: 2023-12-14 17:42:20
分享文章
接口介紹
查看某個存儲桶（Bucket）中指定id的清單（Inventory）任務。
接口約束
無
請求URI
GET /v2/bucket-inventory/list
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionCode | 是 | String | 區域編碼。 | 0001 | |
| bucket | 是 | String | 桶名。 | test | |
| id | 否 | Long | 桶清單任務id，不傳id則查詢全部。 | 1 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 本次請求的結果碼。 | 0 | |
| error | 是 | String | 錯誤碼，創建成功時，不返回該字段。 | ||
| message | 是 | String | 錯誤文本信息，創建成功時，為空字符串。 | ||
| returnObj | 是 | String of Object | 返回結果。 | returnObj |
表 returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | String | 業務返回碼，0表示業務成功。 | 0 | |
| data | 是 | Array of Objects | 業務返回數據。 | data | |
| message | 是 | String | 業務消息。 |
表 data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| owner | 是 | String | 用戶名。 | testopenapi | |
| regionCode | 是 | String | 區域編碼。 | 0001 | |
| origBucket | 是 | String | 源桶。 | 1014-2 | |
| destBucket | 是 | String | 目標桶。 | dest1014-2 | |
| inventoryName | 是 | String | 桶清單名。 | test-inventory-2 | |
| directory | 是 | String | 清單報告生成目錄。 | 測試桶清單1014-2 | |
| keyPrefix | 是 | String | 篩選前綴。 | 1111 | |
| status | 是 | String | 狀態，有效F0A，無效F0X。 | F0A | |
| id | 是 | Long | 模板id。 | 3 | |
| createTime | 是 | Long | 創建時間。 | 1681898974900 | |
| updateTime | 是 | Long | 更新時間。 | 1681898974900 |
請求示例
GET /v2/bucket-inventory/list?regionCode=0001&bucket=test&id=3
響應示例
{
"statusCode": "0",
"message": "",
"returnObj": {
"code": "0",
"data": [
{
"owner": "testopenapi",
"regionCode": "0001",
"origBucket": "1014-2",
"destBucket": "dest1014-2",
"inventoryName": "test-inventory-2",
"directory": "測試桶清單1014-2",
"keyPrefix": "1111",
"status": "F0A",
"updateTime": "1681898975000",
"id": 3,
"createTime": "1681898975000"
}
],
"message": ""
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 0 | 表示業務成功。 |
| 400 | 請求參數有誤。 |
| 403 | 用戶鑒權失敗，用戶無操作權限。 |
| 404 | 請求的資源不存在，輸入錯誤的URL。 |
| 500 | 業務執行異常。 |
