对象存储 POST Bucket inventory-API 文档-文档中心-腾讯云

功能描述
POST Bucket inventory 可以对一个存储桶创建一个一次性清单任务。区别于 PUT Bucket inventory，这个清单任务创建后将立即开始执行，每个任务只会执行一次，而不会周期性地重复执行。通过使用此功能，您能够更加灵活地获取到存储桶的对象清单，进而更精细化地管理对象。
注意
您必须在目标存储桶中写入存储桶策略，以供 COS 将清单任务的结果文件写入该存储桶中。
调用该请求时，请确保您有足够的权限对存储桶的清单任务进行操作。存储桶所有者默认拥有该权限，若您无该项权限，请先向存储桶所有者申请该项操作的权限。  
如果您指定了清单投递的前缀，COS 后端会自动在您指定的前缀后边加上 / 。如您指定了 Prefix 作为前缀，则 COS 后端投递的清单报告路径为 Prefix/inventory_report。
在清单任务未完成前，再次重复提交相同 ID 的清单任务，或者使用与周期性清单任务相同的 ID，服务端会返回重复清单任务的错误。
请求
请求示例
POST /?inventory&id=inventory-id HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
Content-MD5: MD5
说明
Host：<BucketName-APPID>.cos.<Region>.myqcloud.com，其中 <BucketName-APPID> 为带 APPID 后缀的存储桶名字，例如 examplebucket-1250000000，可参见 存储桶概览 > 基本信息 和 存储桶概述 > 存储桶命名规范 文档；<Region> 为 COS 的可用地域，可参见 地域和访问域名 文档。
Authorization：Auth String（详情请参见 请求签名 文档）。
请求参数
调用 POST Bucket inventory 需要使用清单任务名称的参数。该参数格式如下：
参数
描述
类型
是否必选
id
清单任务的名称。缺省值：None
合法字符：a-z，A-Z，0-9，-，_，.
注意：ID 建议不要与周期清单任务 ID 相同。一天内不允许提交重复的 ID，否则会返回失败。
String
是
请求头
此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。
请求体
用户在请求体中使用 XML 语言设置清单任务的具体配置信息，示例如下：
注意
区别于传统的周期任务形式的清单规则，一次性清单不允许携带参数 IsEnabled 与 Schedule。
其余参数与 PUT Bucket inventory 中的参数完全一致。  
一次性清单报告存储路径与周期性清单一致，详情请参见 清单报告存储路径。
<InventoryConfiguration>
    <Id>inventory-id</Id>
    <Destination>
        <COSBucketDestination>
            <Format>CSV</Format>
            <AccountId>100000000001</AccountId>
            <Bucket>qcs::cos:ap-guangzhou::examplebucket-1250000000</Bucket>
            <Prefix>cos_bucket_inventory</Prefix>
            <Encryption>
                <SSE-COS></SSE-COS>
            </Encryption>
        </COSBucketDestination>
    </Destination>
    <Filter>
        <And>
            <Prefix>myPrefix</Prefix>
            <Tag>
                <Key>string</Key>
                <Value>string</Value>
            </Tag>
        </And>
    </Filter>
    <IncludedObjectVersions>All</IncludedObjectVersions>
    <OptionalFields>
        <Field>Size</Field>
        <Field>LastModifiedDate</Field>
        <Field>ETag</Field>
        <Field>StorageClass</Field>
        <Field>IsMultipartUploaded</Field>
        <Field>ReplicationStatus</Field>
        <Field>Tag</Field>
        <Field>Crc64</Field>
        <Field>x-cos-meta-*</Field>
    </OptionalFields>
</InventoryConfiguration>
响应
响应头
此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。
响应体
发起一次性清单任务成功后，会返回 JodId 信息。
<PostInventoryResult>
    <JobId>Dgesgeqzd0dd***==</JobId>
</PostInventoryResult>
具体内容描述如下：
节点名
父节点
﻿
描述
类型
PostInventoryResult
无
一次性清单发起成功后的返回。
Container
JobId
PostInventoryResult
一次性清单任务发器成功后，会返回JodId信息
String
错误码
此接口遵循统一的错误响应和错误码，详情请参见 错误码 文档。
实际案例
案例：使用特定前缀过滤对象生成一次性清单
请求
该示例向存储桶 examplebucket-1250000000 中发起一条名为 disposable 的清单任务。
该清单任务分析存储桶中前缀为 myPrefix ，且有对象标签含有 {age:18} 的对象及其所有版本。
分析维度包括 Size、LastModifiedDate、StorageClass、ETag、Tag。
分析结果将以 CSV 格式文件存储在存储桶 inventorybucket-1250000000 中。
假设清单发起时间为2022年11月20日，清单 Manifest 相关文件会发布在目标存储桶以下路径。
cos_bucket_inventory/1250000000/examplebucket/disposable/20221120/manifest.json
cos_bucket_inventory/1250000000/examplebucket/disposable/20221120/manifest.checksum
POST /?inventory&id=disposable HTTP/1.1
Date: Mon, 28 Aug 2018 02:53:38 GMT
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1503888878;1503889238&q-key-time=1503888878;1503889238&q-header-list=host&q-url-param-list=inventory&q-signature=254bf9cd3d6615e89a36ab652437f9d45c5f****
Content-MD5: AAq9nzrpsz5LJ4UEe1f6Q==
Host: examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com
Content-Length: 1024
﻿
<?xml version = "1.0" encoding = "UTF-8">
<InventoryConfiguration xmlns = "http://....">
    <Id>disposable</Id>
    <Destination>
        <COSBucketDestination>
            <Format>CSV</Format>
            <AccountId>100000000001</AccountId>
            <Bucket>qcs::cos:ap-guangzhou::inventorybucket-1250000000</Bucket>
            <Prefix>cos_bucket_inventory</Prefix>
        </COSBucketDestination>
    </Destination>
    <Filter>
        <And>
            <Prefix>myPrefix</Prefix>
            <Tag>
                <Key>age</Key>
                <Value>18</Value>
            </Tag>
        </And>
    </Filter>
    <IncludedObjectVersions>All</IncludedObjectVersions>
    <OptionalFields>
        <Field>Size</Field>
        <Field>LastModifiedDate</Field>
        <Field>StorageClass</Field>
        <Field>ETag</Field>
        <Field>Tag</Field>
    </OptionalFields>
</InventoryConfiguration>
响应
上述请求后，COS 返回以下响应，表明该清单任务已经成功提交。
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 0
Date: Mon, 28 Aug 2018 02:53:38 GMT
Server: tencent-cos
x-cos-request-id: NTlhMzg1ZWVfMjQ4OGY3MGFfMWE1NF8****
﻿
<PostInventoryResult>
    <JobId>Dgesgeqzd0dd***==</JobId>
</PostInventoryResult>
﻿
参数	描述	类型	是否必选
id	清单任务的名称。缺省值：None 合法字符：`a-z，A-Z，0-9，-，_，.` 注意：ID 建议不要与周期清单任务 ID 相同。一天内不允许提交重复的 ID，否则会返回失败。	String	是
节点名	父节点	描述	类型
PostInventoryResult	无	一次性清单发起成功后的返回。	Container
JobId	PostInventoryResult	一次性清单任务发器成功后，会返回JodId信息	String
POST Bucket inventory

本页目录：

功能描述

请求

请求示例

请求参数

请求头

请求体

响应

响应头

响应体

错误码

实际案例

案例：使用特定前缀过滤对象生成一次性清单

请求

响应
