GetBucketInventory
更新时间：2024-06-18
接口描述
GetBucketInventory 使用GET操作来获取指定桶的某个清单配置。用户在发起该请求时，需要用户提供清单任务的名称
请求
-
请求语法
Plain Text1GET /?inventory&id=inventory-configuration-ID HTTP/1.1 2Host: <BucketName>.bj.bcebos.com 3x-bce-date: date 4Content-Length: 0 -
请求头域
无特殊请求头域
-
请求query参数
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| id | string | inventory规则名 | 是 |
响应
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| 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。 | 是 |
示例
-
请求示例
Plain Text1GET /?inventory&id=inventory-configuration-ID HTTP/1.1 2Host: <BucketName>.bj.bcebos.com 3x-bce-date: date 4Content-Length: 0 -
响应示例
Plain Text1HTTP/1.1 200 OK 2x-bce-request-id: 4db4b34d-653d-4d9a-b49b-3049ca786409 3Date: Wed, 31 May 2018 08:34:40 GMT 4Server: BceBos 5Authorization: AuthorizationString 6{ 7 "id": "inventory-configuration-ID", 8 "status": "enabled", 9 "resource": [ 10 "bucket/prefix/*" 11 ], 12 "schedule": "Weekly", 13 "destination": { 14 "targetBucket": "destBucketName", 15 "targetPrefix": "destination-prefix", 16 "format": "CSV" 17 } 18}