Object Storage Service:PutBucketInventory

Usage notes

You can use an inventory to obtain information about specific objects in a bucket, such as the quantities, sizes, storage classes, and encryption status of the objects. When you configure an inventory 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 an inventory for a bucket, you must create a RAM role. The RAM role must have the permissions to read all objects from the source bucket and write objects to the destination bucket. If you use the bucket inventory feature for the first time, we recommend that you configure an inventory in the Object Storage Service (OSS) console. After you configure the inventory, you can obtain the RAM role that has permissions to read all objects from the source bucket and write objects to the destination bucket. For more information about the permissions of the RAM role for the bucket inventory feature, see Bucket inventory.
• You can configure up to 1,000 inventories for a bucket.
• You must deploy the source bucket for which you want to configure an inventory in the same region as the destination bucket in which the inventory list is stored.

Request syntax

  PUT /?inventory&inventoryId=report1 HTTP/1.1
  Host: BucketName.oss-cn-hangzhou.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>filterPrefix/</Prefix>
           <LastModifyBeginTimeStamp>1637883649</LastModifyBeginTimeStamp>
           <LastModifyEndTimeStamp>1638347592</LastModifyEndTimeStamp>
           <LowerSizeBound>1024</LowerSizeBound>
           <UpperSizeBound>1048576</UpperSizeBound>
           <StorageClass>Standard,IA</StorageClass>
     </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 parameters

Response elements

The response headers that are included 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: oss-example.oss-cn-hangzhou.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>
           <LastModifyBeginTimeStamp>1637883649</LastModifyBeginTimeStamp>
           <LastModifyEndTimeStamp>1638347592</LastModifyEndTimeStamp>
           <LowerSizeBound>1024</LowerSizeBound>
           <UpperSizeBound>1048576</UpperSizeBound>
           <StorageClass>Standard,IA</StorageClass>
       </Filter>
       <Destination>
          <OSSBucketDestination>
            <Format>CSV</Format>
            <AccountId>100000000000000</AccountId>
            <RoleArn>acs:ram::100000000000000:role/AliyunOSSRole</RoleArn>
            <Bucket>acs:oss:::destbucket</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