GetBucketInventory用于查看某个存储空间(Bucket)中指定的清单(Inventory)任务。
注意事项
阿里云账号默认拥有查看Bucket指定清单任务的权限。如果您需要通过RAM用户或者STS的方式进行查看,您必须拥有oss:GetBucketInventory权限。
请求语法
GET /?inventory&inventoryId=inventoryId HTTP/1.1请求元素
| 名称 | 类型 | 是否必选 | 描述 | 
| inventoryId | 字符串 | 是 | 查询的清单规则Id。 | 
响应元素
| 名称 | 类型 | 描述 | 
| Id | 字符串 | 由用户指定的清单名称,清单名称在当前存储空间下必须全局唯一。 | 
| IsEnabled | 布尔 | 清单是否启用的标识。 有效值: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 
 | 
| 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>
SDK
此接口所对应的各语言SDK如下:
命令行工具ossutil
GetBucketInventory接口所对应的ossutil命令,请参见get-bucket-inventory。