GetBucketInventory

注意事項

阿里雲帳號預設擁有查看Bucket指定清單任務的許可權。如果您需要通過RAM使用者或者STS的方式進行查看，您必須擁有oss:GetBucketInventory許可權。

請求文法

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、Monthly或Once 父節點：Schedule
DayOfMonth	正整數	Frequency為Monthly時，每月第幾天匯出清單。取值範圍為1~31的正整數。父節點：Schedule
AutoDelete	布爾	once清單執行後，是否自動刪除once清單配置。僅在Frequency為Once時，才允許存在該欄位。有效值：true、false 父節點：Schedule
IncludedObjectVersions	字串	是否在清單中包含Object版本資訊。有效值：All或Current 如果為All，則匯出Object的所有版本資訊。如果為Current，則匯出Object的目前的版本資訊。
OptionalFields	容器	設定清單結果中應包含的配置項。
Field	字串	清單結果中包含的配置項。可選的配置項：Size、LastModifiedDate、TransitionTime、ETag、StorageClass、IsMultipartUploaded、EncryptionStatus、ObjectAcl、TaggingCount、ObjectType、Crc64 父節點：OptionalFields
IncrementalInventory	容器	增量清單的配置資訊。
IsEnabled	布爾	是否開啟增量清單。有效值： true：開啟 false：關閉當取值為true 時，增量清單功能啟用，不受上層enable=false 的影響。父節點：IncrementalInventory
Schedule	容器	增量清單的匯出周期。父節點：IncrementalInventory
Frequency	正整數	增量清單的匯出頻率，單位為秒。系統當前以 600 秒為固定周期，每個周期自動建立一個目錄首碼，並產生對應的 manifest 檔案及該周期內產生的多份 CSV 檔案。暫不支援自訂頻率設定。父節點：Schedule
OptionalFields	容器	設定增量清單中包含的配置項。父節點：IncrementalInventory
Field	字串	增量清單中包含的配置項。父節點：OptionalFields SequenceNumber：序號，每條記錄的SequenceNumber唯一，同Bucket同Object下的記錄，可按照SequenceNumber排序，通常保證排序後的記錄遵循時間邏輯順序。 RecordType：事件類型：CREATE、UPDATE_METADATA、DELETE CREATE：所選首碼下發生的所有上傳方式，如 Put/Post/Append/MultipartUpload/Copy UPDATE_METADATA：所選首碼下所有中繼資料的更新都記錄在該類型中 DELETE：所選首碼下的檔案的所有刪除方式，如 DeleteObject/DeleteMultipleObjects、開啟多版本後產生 DeleteMarker、生命週期刪除。刪除有DeleteMarker和永久刪除，其中，永久刪除記錄僅保留 `Bucket`、`Key`、`SequenceNumber`、`RecordType`、`RecordTimestamp` 和 `VersionId` 核心欄位，其餘列均為空白（null）。 RecordTimestamp：時間戳記 ( 樣本： "2024-08-25 18:08:01.024")，採用格林威治時區，精度到毫秒。 Requester：要求者的阿里雲 ID 或者 Principal ID。 RequestId：請求的唯一標識。 SourceIp：要求者源 IP。 Key：Bucket 中 Object 的名稱，採用URL編碼。 VersionId：Object的版本ID。僅當配置的清單規則為匯出所有版本時出現此欄位。如果配置清單規則的Bucket未開啟版本控制，則該欄位顯示為空白。如果配置清單規則的Bucket已開啟版本控制，則該欄位顯示為Object的VersionId。 IsDeleteMarker：Object版本是否為刪除標記。僅當配置的清單規則為匯出所有版本時出現此欄位。如果配置清單規則的Bucket未開啟版本控制，則該欄位預設顯示為false。如果配置清單規則的Bucket已開啟版本控制，且Object為刪除標記時，則該欄位顯示為true。如果Object不是刪除標記，則該欄位顯示為false。 Size：Object的大小。 StorageClass：Object的儲存類型。 LastModifiedDate：Object的最後修改時間。 ETag：Object的ETag值，用於標識Object的內容。Object產生時會建立相應的ETag，用於標識一個Object的內容。通過PutObject介面建立的Object，ETag值是其內容的MD5值。通過其他方式建立的Object，ETag值是基於一定計算規則產生的唯一值，但不是其內容的MD5值。 IsMultipartUploaded：是否為通過分區上傳方式上傳的Object。 ObjectType：Object類型。 ObjectAcl：Object的讀寫權限。 Crc64：Object的CRC64。 EncryptionStatus：Object是否加密。

樣本

請求樣本

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。