接口介绍
列出某个存储桶(Bucket)中的所有清单(Inventory)任务。
接口约束
无
请求URI
GET /v1/bucket-inventory/list
请求参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionCode | 是 | String | 区域编码 | String | |
bucket | 是 | String | 桶名 | String |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
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 |
表returnObj
请求示例
GET /v1/bucket-inventory/list?regionCode=0001&bucket=test
响应示例
{
"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 | 业务执行异常 |