GetBucketInventory用于查看某个存储空间（Bucket）中指定的清单（Inventory）任务。

说明 调用该请求时，请确保您有足够的权限对存储空间的清单任务进行操作。存储空间所有者默认拥有该权限，若您无该项权限，请先向存储空间所有者申请该项操作的权限。

请求语法

GET /?inventory&inventoryId=inventoryId HTTP/1.1

请求元素

名称 类型 是否必选 描述
inventoryId 字符串 是 查询的清单规则Id。

响应元素

名称 类型 是否必选 描述
Id 字符串 是 由用户指定的清单名称，清单名称在当前存储空间下必须全局唯一。
IsEnabled 布尔 是 清单是否启用的标识。
有效值：true或false
  • 如果设置为true，清单功能将生效。
  • 如果设置为false，将不生成任何清单。
Filter 容器 否 清单筛选的前缀。指定前缀后，清单将筛选出符合前缀设置的对象。
Prefix 字符串 否 筛选规则的匹配前缀。

父节点：Filter
Destination 容器 是 存放清单结果的信息。
OSSBucketDestination 容器 是 清单结果导出后存放的存储空间信息。

父节点：Destination
Format 字符串 是 导出清单文件的文件格式。

有效值：CSV

父节点：OSSBucketDestination
AccountId 字符串 是 存储空间所有者授予的账户ID。

父节点：OSSBucketDestination
RoleArn 字符串 是 存储空间所有者授予操作权限的角色名。

格式为：acs:ram::uid:role/rolename

父节点：OSSBucketDestination
Bucket 字符串 是 存放导出的清单文件的存储空间。

父节点：OSSBucketDestination
Prefix 字符串 否 清单文件的存储路径前缀。

父节点：OSSBucketDestination
Encryption 容器 否 清单文件的加密方式。

有效值：SSE-OSS、SSE-KMS或空

父节点：OSSBucketDestination
SSE-OSS 容器 否 SSE-OSS加密方式的容器。

父节点：Encryption
SSE-KMS 容器 否 用于保存SSE-KMS加密方式下的密钥的容器。

父节点：Encryption
KeyId 字符串 否 KMS密钥id。

父节点：SSE-KMS
Schedule 容器 是 存放清单导出周期信息的容器。
Frequency 字符串 是 清单文件导出的周期。

有效值：Daily或Weekly

父节点：Schedule
IncludedObjectVersions 字符串 是 是否在清单中包含Object版本信息。
有效值：All或Current
  • 如果为All，则导出Object的所有版本信息。
  • 如果为Current，则导出Object的当前版本信息。
OptionalFields 容器 否 设置清单结果中应包含的配置项。
Field 容器 否 清单结果中包含的配置项。

可选的配置项：Size、LastModifiedDate、ETag、StorageClass、IsMultipartUploaded、EncryptionStatus

父节点：OptionalFields

示例

  • 请求示例 
    GET /?inventory&inventoryId=list1 HTTP/1.1
  • 返回示例 
      HTTP/1.1 200 OK
  x-oss-request-id: 56594298207FB304438516F9
  Date: Mon, 31 Oct 2016 12:00:00 GMT
  Server: AliyunOSS
  Content-Length: length

  <?xml version="1.0" encoding="UTF-8"?>
  <InventoryConfiguration">
     <Id>report1</Id>
     <IsEnabled>true</IsEnabled>
     <Destination>
        <OSSBucketDestination>
           <Format>CSV</Format>
           <AccountId>1000000000000000</AccountId>
           <RoleArn>acs:ram::1000000000000000:role/AliyunOSSRole</RoleArn>
           <Bucket>acs:oss:::bucket_0001</Bucket>
           <Prefix>prefix1</Prefix>
           <Encryption>
              <SSE-OSS/>
           </Encryption>
        </OSSBucketDestination>
     </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>EncryptionStatus</Field>
     </OptionalFields>
  </InventoryConfiguration>