すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:GetBucketInventory

最終更新日:Jun 10, 2025

指定したバケットのインベントリをクエリします。

使用方法

デフォルトでは、Alibaba Cloud アカウントには、バケットの指定されたインベントリをクエリする権限があります。 RAM ユーザーまたは STS を使用してバケットの指定されたインベントリをクエリするには、oss:GetBucketInventory 権限が必要です。

リクエスト構文

GET /?inventory&inventoryId=inventoryId HTTP/1.1

リクエストパラメーター

パラメーター

タイプ

必須

説明

inventoryId

String

はい

クエリするインベントリの ID。

レスポンスパラメーター

パラメーター

タイプ

説明

Id

String

指定されたインベントリ名。バケット内でグローバルに一意である必要があります。

IsEnabled

ブール値

インベントリ機能が有効になっているかどうかを示します。

有効な値: true および false

  • true の値は、インベントリ機能が有効になっていることを示します。

  • false の値は、インベントリリストが生成されないことを示します。

Filter

コンテナー

オブジェクトのフィルタリングに使用するプレフィックスを格納するコンテナー。指定されたプレフィックスを含む名前のオブジェクトのみがインベントリリストに含まれます。

Prefix

String

インベントリで指定されたプレフィックス。

親ノード: Filter

Destination

コンテナー

エクスポートされたインベントリリストに関する情報を格納するコンテナー。

OSSBucketDestination

コンテナー

エクスポートされたインベントリリストを格納するバケットに関する情報。

親ノード: Destination

Format

String

エクスポートされたインベントリリストのフォーマット。

有効な値: CSV

親ノード: OSSBucketDestination

AccountId

String

バケットオーナーによって付与されたアカウント ID。

親ノード: OSSBucketDestination

RoleArn

String

バケットオーナーが権限を付与するロールの名前。

フォーマット: acs:ram::uid:role/rolename

親ノード: OSSBucketDestination

Bucket

String

エクスポートされたインベントリリストが格納されるバケット。

親ノード: OSSBucketDestination

Prefix

String

エクスポートされたインベントリリストが格納されるパスに含まれるプレフィックス。

親ノード: OSSBucketDestination

Encryption

コンテナー

エクスポートされたインベントリリストの暗号化方法を格納するコンテナー。

有効な値: SSE-OSS、SSE-KMS、および Null

親ノード: OSSBucketDestination

SSE-OSS

コンテナー

SSE-OSS 暗号化方法に関する情報を格納するコンテナー。

親ノード: Encryption

SSE-KMS

コンテナー

SSE-KMS 暗号化方式で使用されるカスタマーマスターキー (CMK) を格納するコンテナー。

親ノード: Encryption

KeyId

String

Key Management Service (KMS) によって管理されるキーの ID。

親ノード: SSE-KMS

Schedule

コンテナー

インベントリリストがエクスポートされる頻度に関する情報を格納するコンテナー。

Frequency

String

インベントリリストがエクスポートされる頻度。

有効な値: Daily および Weekly

親ノード: Schedule

IncludedObjectVersions

String

オブジェクトに関するバージョン情報をインベントリリストに含めるかどうかを示します。

有効な値: All および Current

  • All の値は、オブジェクトのすべてのバージョンがエクスポートされることを示します。

  • Current の値は、オブジェクトの現在のバージョンのみがエクスポートされることを示します。

OptionalFields

コンテナー

インベントリリストに含まれる構成フィールドを格納するコンテナー。

Field

String

インベントリリストに含まれる構成フィールド。

有効な値: 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>

OSS SDK

以下のプログラミング言語の OSS SDK を使用して、GetBucketInventory を呼び出すことができます。

ossutil

GetBucketInventory 操作に対応する ossutil コマンドについては、「get-bucket-inventory」をご参照ください。