全部產品
Search
文件中心

Object Storage Service:ListBucketInventory

更新時間:Feb 28, 2024

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

  • 如果值為false,則表明儲存空間中的所有清單任務已全部列出。

  • 如果值為true,表示還未完整列出儲存空間中的所有清單任務,您可以將NextContinuationToken欄位的值作為下一次list請求的continuation-token參數,以擷取下一頁的清單配置列表。

NextContinuationToken

字串

當響應中的IsTruncated為true且NextContinuationToken非空時,使用該欄位作為下一次list請求的continuation-token參數。

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或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

  • 如果為All,則匯出Object的所有版本資訊。

  • 如果為Current,則匯出Object的目前的版本資訊。

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>