PutBucketInventory

注意事项

您可以通过清单获取Bucket中Object的各类信息，包括Object的数量、大小、存储类型、加密状态等。配置清单规则时，有如下注意事项：

• 配置清单规则前需生成一个RAM角色，该角色需要拥有读取源Bucket所有文件和向目标Bucket写入文件的权限。首次使用清单功能时，建议您通过OSS控制台进行配置。清单规则配置完成后，您可以获取拥有所有权限的RAM角色。有关配置清单规则中RAM角色的权限说明，请参见存储空间清单。

• 单个Bucket最多只能配置1000条清单规则。

• 配置清单的源Bucket与存放导出的清单文件所在的目标Bucket必须位于同一个Region。

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限，需要阿里云账号或账号管理员通过RAM Policy或Bucket Policy授予操作权限。

请求语法

  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>TransistionTime</Field>        
        <Field>ETag</Field>
        <Field>StorageClass</Field>
        <Field>IsMultipartUploaded</Field>
        <Field>EncryptionStatus</Field>
     </OptionalFields>
  </InventoryConfiguration>

请求元素

响应元素

此接口仅涉及公共响应头，例如Content-Length、Date等。更多信息，请参见公共响应头（Common Response Headers）。

示例

• 请求示例

    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>TransistionTime</Field>   
          <Field>ETag</Field>
          <Field>StorageClass</Field>
          <Field>IsMultipartUploaded</Field>
          <Field>EncryptionStatus</Field>
       </OptionalFields>
    </InventoryConfiguration>

• 返回示例

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

SDK

此接口所对应的各语言SDK如下：

• Java

• Python V2

• Go V2

• Node.js

• C++

• .NET

命令行工具ossutil

PutBucketInventory接口所对应的ossutil命令，请参见put-bucket-inventory。

错误码