ListBucketInventory用于批量获取某个存储空间(Bucket)中的所有清单(Inventory)任务。
单次请求最多可获取100条清单配置项内容。若需获取超过100条清单配置项,则需发送多次请求,并保留相应的token,作为下一次请求的参数。
调用该请求时,请确保您有足够的权限对存储空间的清单任务进行操作。存储空间所有者默认拥有该权限,若您无该项权限,请先向存储空间所有者申请该项操作的权限。
请求语法
带continuation-token的形式
GET /?inventory&continuation-token=xxx HTTP/1.1
不带continuation-token的形式
GET /?inventory HTTP/1.1
响应元素
名称 | 类型 | 描述 |
InventoryConfiguration | 容器 | 存放清单配置参数的容器。 |
IsTruncated | 布尔 | 是否列举全部的清单任务。 有效值:true或false
|
NextContinuationToken | 字符串 | 当响应中的IsTruncated为true且NextContinuationToken非空时,使用该字段作为下一次list请求的continuation-token参数。 |
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或Null 父节点: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 HTTP/1.1 Host: BucketName.oss.aliyuncs.com Date: Fri, 24 Feb 2012 03:55:00 GMT Authorization: authorization string Content-Type: text/plain
返回示例
HTTP/1.1 200 OK x-oss-request-id: 56594298207FB304438516F9 Date: Sat, 30 Apr 2016 23:29:37 GMT Content-Type: application/xml Content-Length: length Connection: close Server: AliyunOSS <?xml version="1.0" encoding="UTF-8"?> <ListInventoryConfigurationsResult> <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:::destination-bucket</Bucket> <Prefix>prefix1</Prefix> </OSSBucketDestination> </Destination> <Schedule> <Frequency>Daily</Frequency> </Schedule> <Filter> <Prefix>prefix/One</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> <InventoryConfiguration> <Id>report2</Id> <IsEnabled>true</IsEnabled> <Destination> <OSSBucketDestination> <Format>CSV</Format> <AccountId>1000000000000000</AccountId> <RoleArn>acs:ram::1000000000000000:role/AliyunOSSRole</RoleArn> <Bucket>acs:oss:::destination-bucket</Bucket> <Prefix>prefix2</Prefix> </OSSBucketDestination> </Destination> <Schedule> <Frequency>Daily</Frequency> </Schedule> <Filter> <Prefix>prefix/Two</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> <InventoryConfiguration> <Id>report3</Id> <IsEnabled>true</IsEnabled> <Destination> <OSSBucketDestination> <Format>CSV</Format> <AccountId>1000000000000000</AccountId> <RoleArn>acs:ram::1000000000000000:role/AliyunOSSRole</RoleArn> <Bucket>acs:oss:::destination-bucket</Bucket> <Prefix>prefix3</Prefix> </OSSBucketDestination> </Destination> <Schedule> <Frequency>Daily</Frequency> </Schedule> <Filter> <Prefix>prefix/Three</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> ... <IsTruncated>true</IsTruncated> <NextContinuationToken>...</NextContinuationToken> </ListInventoryConfigurationsResult>