Overview

This API is used to create an inventory job for a bucket. For more information, see Inventory Overview.

Note：

• You can create up to 1,000 inventory jobs for each COS bucket.
• You must add a bucket policy to the destination bucket for COS to write the output file of the inventory job to the destination bucket.
• To call this API, ensure that you have obtained required permissions from the bucket owner to operate on the inventory jobs for the bucket. The bucket owner has such permissions by default. For the authorization directions, please see Inventory Overview - Directions.
• If you specify a prefix for the destination path of the inventory report, COS will automatically append a slash (/) to the specified prefix. For example, if you set the prefix to Prefix, COS will deliver the inventory report to Prefix/inventory_report.

Request

Sample request

PUT /?inventory&id=inventory-configuration-ID HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
Content-MD5: MD5

Note：

• In Host: <bucketname-appid>.cos.<region>.myqcloud.com, is the bucket name followed by the APPID, such as examplebucket-1250000000 (see Bucket Overview > Basic Information and Bucket Overview > Bucket Naming Conventions), and is a COS region (see Regions and Access Endpoints).
• Authorization: Auth String (See Request Signature for details.)

Request parameters

To call PUT Bucket inventory, specify the following parameter:

Request headers

This API only uses Common Request Headers.

Request body

You can configure the inventory job in the request body using the XML markup language. The configuration includes objects to analyze, analysis frequency, analysis dimensions, and the format and destination path of the analysis result.

<InventoryConfiguration>
<Id>list1</Id>
<IsEnabled>true</IsEnabled>
<Destination>
   <COSBucketDestination>
       <Format>CSV</Format>
       <AccountId>100000000001</AccountId>
       <Bucket>qcs::cos:ap-guangzhou::examplebucket-1250000000</Bucket>
       <Prefix>list1</Prefix>
       <Encryption>
           <SSE-COS></SSE-COS>
       </Encryption>
   </COSBucketDestination>
</Destination>
<Schedule>
   <Frequency>Daily</Frequency>
</Schedule>
<Filter>
   <Prefix>myPrefix</Prefix>
</Filter>
<IncludedObjectVersions>All</IncludedObjectVersions>
<OptionalFields>
   <Field>Size</Field>
   <Field>LastModifiedDate</Field>
   <Field>ETag</Field>
   <Field>StorageClass</Field>
   <Field>IsMultipartUploaded</Field>
   <Field>ReplicationStatus</Field>
</OptionalFields>
</InventoryConfiguration>

The nodes are described as follows:

Response

Response headers

This API only returns Common Response Headers.

Response body

The response body is empty.

Error codes

This API returns common error responses and error codes. For more information, please see Error Codes.

Samples

Request

This sample adds an inventory job named list1 to the examplebucket-1250000000 bucket.

• Objects to analyze: objects prefixed with myPrefix and all their versions in the bucket
• Analysis frequency: daily
• Analysis dimensions: Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, and ReplicationStatus
• Analysis result: to be stored in the examplebucket-1250000000 bucket as a CSV file, which is prefixed with list1 and encrypted with SSE-COS.

PUT /?inventory&id=list1 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>list1</Id>
<IsEnabled>true</IsEnabled>
<Destination>
    <COSBucketDestination>
        <Format>CSV</Format>
        <AccountId>100000000001</AccountId>
        <Bucket>qcs::cos:ap-guangzhou::examplebucket-1250000000</Bucket>
        <Prefix>list1</Prefix>
        <Encryption>
            <SSE-COS></SSE-COS>
        </Encryption>
    </COSBucketDestination>
</Destination>
<Schedule>
    <Frequency>Daily</Frequency>
</Schedule>
<Filter>
    <Prefix>myPrefix</Prefix>
</Filter>
<IncludedObjectVersions>All</IncludedObjectVersions>
<OptionalFields>
    <Field>Size</Field>
    <Field>LastModifiedDate</Field>
    <Field>ETag</Field>
    <Field>StorageClass</Field>
    <Field>IsMultipartUploaded</Field>
    <Field>ReplicationStatus</Field>
</OptionalFields>
</InventoryConfiguration>

Response

The response below indicates that the inventory job list1 has been successfully configured.

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****