tencent cloud

Overview

This API is used to query an inventory job of a bucket. When calling this API, you need to specify the inventory job ID and carry a request signature. For more information, please see Inventory Overview.

Note：

• To call this API, ensure that you have the necessary permission on the bucket inventory job.
• The bucket owner has such permission by default. If you do not have the permission, you can request it from the bucket owner.
• 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

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

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 more information).

Request parameters

To call GET Bucket inventory, specify the following parameter:

Request headers

This API only uses common request headers. For more information, please see Common Request Headers.

Request body

The request body of this request is empty.

Response

Response headers

This API returns only common response headers. For more information, please see Common Response Headers.

Response body

The response body returns application/xml data. The following contains all the nodes:

<InventoryConfiguration>
<Id>list1</Id>
<IsEnabled>true</IsEnabled>
<Destination>
    <COSBucketDestination>
        <Format>CSV</Format>
        <AccountId>1250000000</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:

Error codes

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

Sample

Request

The following example queries the list1 inventory job configuration of the examplebucket-1250000000 bucket:

GET /?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=1503895278;1503895638&q-key-time=1503895278;1503895638&q-header-list=host&q-url-param-list=inventory&q-signature=f77900be432072b16afd8222b4b349aabd83****
Host: examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com

Response

After the request above is made, COS returns the following response, indicating that the inventory job list1 is currently enabled in the bucket:

• Objects to analyze: objects prefixed with myPrefix and all their versions in the examplebucket-1250000000 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.

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 331
Date: Mon, 28 Aug 2018 02:53:39 GMT
Server: tencent-cos
x-cos-request-id: NTlhMzg1ZWVfMjQ4OGY3MGFfMWE1NF84Y2M
<?xml version = "1.0" encoding = "UTF-8">
<InventoryConfiguration xmlns = "http://....">
<Id>list1</Id>
<IsEnabled>true</IsEnabled>
<Destination>
    <COSBucketDestination>
        <Format>CSV</Format>
        <AccountId>1250000000</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>