すべてのプロダクト
Search

このプロダクト

    Object Storage Service:ListBucketInventory

    ドキュメントセンター

    Object Storage Service:ListBucketInventory

    最終更新日:Jun 09, 2025

    この操作を呼び出すと、バケットに対して構成されているすべてのインベントリ タスクをクエリできます。

    説明

    • 1 回のリクエストで最大 100 件のインベントリ構成をクエリできます。 100 件を超えるインベントリ構成をクエリするには、複数のリクエストを送信し、各リクエストのトークンを保持して、次のリクエストのパラメーターとして使用してください。

    • この操作を呼び出すには、バケットのインベントリ タスクに対する操作を実行する権限を持っていることを確認してください。 デフォルトでは、バケットの所有者には、この操作を実行する権限があります。 権限がない場合は、バケットの所有者に権限を申請してください。

    リクエスト構文

    • continuation-token を含むリクエスト

      GET /? inventory&continuation-token=xxx HTTP/1.1

    • continuation-token を含まないリクエスト

      GET /? inventory HTTP/1.1

    レスポンス要素

    要素

    タイプ

    説明

    InventoryConfiguration

    コンテナー

    インベントリ構成を格納するコンテナー。

    IsTruncated

    ブール値

    バケットに構成されているすべてのインベントリ タスクをリストするかどうかを指定します。

    有効な値：true および false

    • false の値は、バケットに構成されているすべてのインベントリ タスクがリストされていることを示します。

    • true の値は、バケットに構成されているすべてのインベントリ タスクがリストされているわけではないことを示します。 インベントリ構成の次のページをリストするには、次のリクエストの continuation-token パラメーターを、現在のリクエストへのレスポンスの NextContinuationToken ヘッダーの値に設定します。

    NextContinuationToken

    文字列

    レスポンスの IsTruncated の値が true で、このヘッダーの値が null でない場合は、次のリクエストの 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 暗号化方式で使用される CMK を格納するコンテナー。

    親ノード：Encryption

    KeyId

    文字列

    SSE-KMS 暗号化方式で使用される CMK。

    親ノード：SSE-KMS

    Schedule

    コンテナー

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

    Frequency

    文字列

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

    有効な値：Daily および Weekly

    親ノード：Schedule

    IncludedObjectVersions

    文字列

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

    有効な値：All および Current

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

    OSS SDK

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

    ossutil

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