PutBucketInventory
更新时间:2024-06-18
接口描述
PutBucketInventory 用于为源bucket中创建清单任务,您可以对清单任务命名后,使用该请求创建清单任务。
Bos建议用户创建一个生命周期策略,用于删除旧的清单列表文件。
注意:
- 用户必须是源Bucket的owner且拥有FULL_CONTROL权限,且是目标Bucket的owner。
- 目的Bucket和源Bucket必须存在,目的Bucket和源Bucket必须是同账号下的Bucket,且是同region下的Bucket,不支持跨账号输出。
- BOS支持在每个存储桶中创建最多20条清单任务。
- 清单列表提供了新对象和覆盖的 PUT 的最终一致性,并提供了 DELETE 的最终一致性。清单列表是Bucket的滚动快照,内容最终是一致的 ,清单可能不包含最近添加或删除的对象。
请求
-
请求语法
PUT /?inventory&id=inventory-configuration-ID HTTP/1.1 Host: <BucketName>.bj.bcebos.com x-bce-date: date Content-Length: request-body length Content-Type: application/json; charset=utf-8 Authorization: AuthorizationString { "id": "inventory-configuration-ID", "status": "enabled", "resource": [ "bucket/prefix/*" ], "schedule": "Weekly", "destination": { "targetBucket": "destBucketName", "targetPrefix": "destination-prefix", "format": "CSV" } }
-
请求头域
无
-
请求参数
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
id | string | inventory规则名。规格:最长64字节。合法字符:"a-z"、"A-Z"、"0-9"、"-"、"_"和"." 。 | 是 |
status | string | 清单是否生效的标识。如果设置为 “enabled”,清单功能将生效;如果设置为"disabled",将不生成任何清单 | 是 |
resource | list | 子元素为string类型。生效前缀,resource的配置形式为bucket_name/<生效的对象前缀> ,必须要以bucket_name/ 开头.对整个bucket生效的时候,使用bucket_name/* 。 |
是 |
schedule | string | 清单任务周期,可选项为每三日、每周、每月,可选值:ThreeDaily、Weekly、Monthly。 | 是 |
monthlyDate | int | 如果清单任务周期选择了按月,需要明确指定清单产出的日期。支持填入 1-28 范围内的整数。 | 否 |
destination | object | 描述存放清单结果的信息。 | 是 |
+targetBucket | string | 指定存放清单文件的Bucket。 | 是 |
+targetPrefix | string | 指定最终被保存的清单文件前缀。 | 否 |
+format | string | 清单分析结果的文件形式,当前支持格式:CSV。 | 是 |
响应
示例
-
请求示例
PUT /?inventory&id=inventory-configuration-ID HTTP/1.1 Host: <BucketName>.bj.bcebos.com x-bce-date: date Content-Length: request-body length Content-Type: application/json; charset=utf-8 Authorization: AuthorizationString { "id": "inventory-configuration-ID", "status": "enabled", "resource": [ "bucket/prefix/*" ], "schedule": "Weekly", "destination": { "targetBucket": "destBucketName", "targetPrefix": "destination-prefix", "format": "CSV" } }
-
响应示例
HTTP/1.1 200 OK x-bce-request-id: 4db4b34d-653d-4d9a-b49b-3049ca786409 Date: Wed, 31 May 2018 08:34:40 GMT Server: BceBos