接口介绍
为指定存储桶(Bucket)配置清单(Inventory)规则。
接口约束
无
请求URI
POST /v1/bucket-inventory/add
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
content-type | 是 | String | 请求header参数,默认为applicatin/json | applicatin/json |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionCode | 是 | String | 区域编码 | 0001 | |
origBucket | 是 | String | 源桶 | testBucketName | |
destBucket | 是 | String | 目标桶 | testBucketName | |
inventoryName | 是 | String | 桶清单名 | test-inventory-2 | |
directory | 否 | String | 清单报告生成目录 | 测试桶清单1014-2 | |
keyPrefix | 否 | String | 筛选前缀 | 1111 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 本次请求的结果码 | 0 | |
error | 是 | String | 错误码,创建成功时,不返回该字段 | ||
message | 是 | String | 错误文本信息,创建成功时,为空字符串 | ||
returnObj | 是 | String of Object | 返回结果 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
createTime | Long | 创建时间 | 1681898974900 | |
destBucket | String | 目标桶 | testBucketName | |
directory | String | 清单报告生成目录 | 测试桶清单1014-2 | |
id | Integer | 桶清单模板id | 1 | |
inventoryName | String | 桶清单名 | test-inventory-2 | |
keyPrefix | String | 筛选前缀 | 1111 | |
origBucket | String | 源桶 | testBucketName | |
owner | String | 用户名 | testuser | |
regionCode | String | 区域编码 | 0001 | |
status | String | 状态,有效F0A,无效F0X | F0A | |
updateTime | Long | 更新时间 | 1681898974900 |
请求示例
POST /v1/bucket-inventory/add
请求头header
content-type:applicatin/json
请求体body
{
"regionCode":"0001",
"origBucket":"1014-2",
"destBucket":"dest1014-2",
"inventoryName":"test-inventory-2",
"directory":"测试桶清单1014-2",
"keyPrefix":"test-2"
}
响应示例
{
"statusCode":"0",
"message":" ",
"returnObj":{
"createTime":1697039401055,
"destBucket":"lan2","directory":
"eop测试桶清单","id":100000000059,
"inventoryName":"eqqqqq",
"keyPrefix":"eop-test",
"origBucket":"lan1",
"owner":" chenyang-est",
"regionCode":"0891001",
"status":"F0A",
"updateTime":1697039401055}
}
状态码
状态码 | 描述 |
---|---|
0 | 表示业务成功 |
400 | 请求参数有误 |
403 | 用户鉴权失败,用户无操作权限 |
404 | 请求的资源不存在,输入错误的URL |
500 | 业务执行异常 |