PutBucketInventory

Usage notes

You can use the bucket inventory feature to export the information about specific objects in a bucket, such as the number, sizes, storage classes, and encryption status of the objects. When you configure inventories for a bucket, take note of the following items:

• Only the bucket owner or users that have the PutBucketInventory permission on the bucket can initiate a PutBucketInventory request.
• Before you configure inventories, you must create a Resource Access Management (RAM) role. The RAM role must have permissions to read all objects from the source bucket and write objects to the destination bucket. If you use the inventory feature for the first time, we recommend that you configure this feature in the Object Storage Service (OSS) console. After you configure an inventory, you can obtain the RAM role that has permissions to read objects from the source bucket and write objects to the destination bucket. For more information about permissions of the RAM role for the inventory feature, see Bucket inventory.
• You can configure up to 1,000 inventories for a bucket.
• Inventory lists must be stored in a bucket in the same region as the bucket for which the inventory feature is configured.

Request structure

  <InventoryConfiguration>
     <Id>report1</Id>
     <IsEnabled>true</IsEnabled>
     <Filter>
        <Prefix>filterPrefix</Prefix>
     </Filter>
     <Destination>
        <OSSBucketDestination>
           <Format>CSV</Format>
           <AccountId>1000000000000000</AccountId>
           <RoleArn>acs:ram::1000000000000000:role/AliyunOSSRole</RoleArn>
           <Bucket>acs:oss:::destination-bucket</Bucket>
           <Prefix>prefix1</Prefix>
           <Encryption>
              <SSE-KMS>
                 <KeyId>keyId</KeyId>
              </SSE-KMS>
           </Encryption>
        </OSSBucketDestination>
     </Destination>
     <Schedule>
        <Frequency>Daily</Frequency>
     </Schedule>
     <IncludedObjectVersions>All</IncludedObjectVersions>
     <OptionalFields>
        <Field>Size</Field>
        <Field>LastModifiedDate</Field>
        <Field>ETag</Field>
        <Field>StorageClass</Field>
        <Field>IsMultipartUploaded</Field>
        <Field>EncryptionStatus</Field>
     </OptionalFields>
  </InventoryConfiguration>

Request elements

Response elements

The response headers involved in this API operation contain only common response headers such as Content-Length and Date. For more information, see Common response headers.

Examples

• Sample requests

    PUT /?inventory&inventoryId=report1 HTTP/1.1
    Host: BucketName.oss.aliyuncs.com
    Date: Mon, 31 Oct 2016 12:00:00 GMT
    Authorization: authorization string
    Content-Length: length
  
    <?xml version="1.0" encoding="UTF-8"?>
    <InventoryConfiguration>
       <Id>report1</Id>
       <IsEnabled>true</IsEnabled>
       <Filter>
          <Prefix>Pics</Prefix>
       </Filter>
       <Destination>
          <OSSBucketDestination>
             <Format>CSV</Format>
             <AccountId>100000000000000</AccountId>
             <RoleArn>acs:ram::100000000000000:role/AliyunOSSRole</RoleArn>
             <Bucket>acs:oss:::bucket_0001</Bucket>
             <Prefix>prefix1</Prefix>
             <Encryption>
                <SSE-KMS>
                   <KeyId>keyId</KeyId>
                </SSE-KMS>
             </Encryption>
          </OSSBucketDestination>
       </Destination>
       <Schedule>
          <Frequency>Daily</Frequency>
       </Schedule>
       <IncludedObjectVersions>All</IncludedObjectVersions>
       <OptionalFields>
          <Field>Size</Field>
          <Field>LastModifiedDate</Field>
          <Field>ETag</Field>
          <Field>StorageClass</Field>
          <Field>IsMultipartUploaded</Field>
          <Field>EncryptionStatus</Field>
       </OptionalFields>
    </InventoryConfiguration>

• Sample responses

    HTTP/1.1 200 OK
    x-oss-request-id: 56594298207FB3044385****
    Date: Mon, 31 Oct 2016 12:00:00 GMT
    Content-Length: 0
    Server: AliyunOSS

Error codes