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

Object Storage Service:GetBucketInventory

最終更新日:Jun 12, 2026

GetBucketInventory API は、バケットの指定のインベントリ設定を返します。

注意事項

デフォルトでは、Alibaba Cloud アカウントの所有者はインベントリ設定を取得できます。 RAM ユーザーとして、または STS トークンを使用してこの操作を実行するには、oss:GetBucketInventory アクセス許可が必要です。

リクエスト構文

GET /?inventory&inventoryId=inventoryId HTTP/1.1

リクエストパラメーター

パラメーター

タイプ

必須

説明

inventoryId

string

はい

照会するインベントリ設定の ID。

レスポンス要素

パラメーター

タイプ

説明

Id

string

ユーザーが指定したインベントリ設定の名前。 この名前は、バケット内で一意である必要があります。

IsEnabled

boolean

インベントリが有効かどうかを示します。

有効な値: true、false

  • true :インベントリが生成されます。

  • false :インベントリは生成されません。

Filter

コンテナー

オブジェクトのフィルタリングに使用するプレフィックスのコンテナー。 このプレフィックスに名前が一致するオブジェクトのみがインベントリに含まれます。

Prefix

string

オブジェクトのフィルタリングに使用するプレフィックス。

親: Filter

Destination

コンテナー

インベントリの結果の送信先に関する情報のコンテナー。

OSSBucketDestination

コンテナー

インベントリの結果を格納する OSS バケットのコンテナー。

親: Destination

Format

string

インベントリファイルの形式。

有効な値: CSV

親: OSSBucketDestination

AccountId

string

送信先バケットを所有する Alibaba Cloud アカウントの ID。

親: OSSBucketDestination

RoleArn

string

OSS が送信先バケットへの書き込みに使用する RAM ロールの Alibaba Cloud リソースネーム (ARN)。

形式: acs:ram::uid:role/rolename

親: OSSBucketDestination

Bucket

string

インベントリファイルを格納する送信先バケット。

親: OSSBucketDestination

Prefix

string

インベントリファイルのパスに使用するプレフィックス。

親: OSSBucketDestination

Encryption

コンテナー

インベントリファイルのサーバーサイド暗号化設定のコンテナー。

有効な値: SSE-OSS、SSE-KMS、または空

親: OSSBucketDestination

SSE-OSS

コンテナー

OSS マネージドキー (SSE-OSS) を使用するサーバーサイド暗号化設定のコンテナー。

親: Encryption

SSE-KMS

コンテナー

KMS マネージドキー (SSE-KMS) を使用するサーバーサイド暗号化設定のコンテナー。

親: Encryption

KeyId

string

KMS マスターキーの ID。

親: SSE-KMS

Schedule

コンテナー

インベントリを生成するためのスケジュールのコンテナー。

Frequency

string

インベントリを生成する頻度を決定します。

有効な値: Daily、Weekly、Monthly、Once

親: Schedule

DayOfMonth

正の整数

Frequency が Monthly の場合にインベントリを生成する日付。 有効な値は 1 から 31 までの正の整数です。

親: Schedule

AutoDelete

boolean

インベントリ設定を一度実行した後に自動的に削除するかどうかを示します。 このパラメーターは、Frequency が Once の場合にのみ有効です。

有効な値: true、false

親: Schedule

IncludedObjectVersions

string

インベントリに含めるオブジェクトのバージョンを決定します。

有効な値: All、Current

  • All :オブジェクトのすべてのバージョンを含みます。

  • Current :オブジェクトの現在のバージョンのみを含みます。

OptionalFields

コンテナー

インベントリに含めるオプションフィールドのコンテナー。

Field

string

インベントリに含めるオプションフィールド。

オプションフィールド: Size、LastModifiedDate、TransitionTime、ETag、StorageClass、IsMultipartUploaded、EncryptionStatus、ObjectAcl、TaggingCount、ObjectType、Crc64

親: OptionalFields

IncrementalInventory

コンテナー

増分インベントリ設定のコンテナー。

IsEnabled

boolean

増分インベントリを有効にするかどうかを示します。

有効な値:

  • true :増分インベントリを有効にします。

  • false :増分インベントリを無効にします。

このパラメーターが true の場合、親の IsEnabled パラメーターが false であっても増分インベントリは有効になります。

親: IncrementalInventory

Schedule

コンテナー

増分インベントリを生成するためのスケジュールのコンテナー。

親: IncrementalInventory

Frequency

正の整数

増分インベントリを生成する頻度 (秒単位)。

現在、システムは 600 秒の固定周期を使用しています。 各周期中に、システムは自動的にディレクトリプレフィックスを作成し、その周期のマニフェストファイルと複数の CSV ファイルを生成します。 カスタムの頻度設定はサポートしていません。

親: Schedule

OptionalFields

コンテナー

増分インベントリに含めるオプションフィールドのコンテナー。

親: IncrementalInventory

Field

string

増分インベントリに含めるオプションフィールド。

親: OptionalFields

  • SequenceNumber :シーケンス番号。 各レコードの一意の識別子です。 同じバケットとオブジェクトに属するレコードは SequenceNumber でソートでき、通常は時系列順になります。

  • RecordType :レコードタイプ: CREATE、UPDATE_METADATA、DELETE

    • CREATE:指定のプレフィックス配下での PutObject、PostObject、AppendObject、MultipartUpload、CopyObject などのすべてのアップロード操作を含みます。

    • UPDATE_METADATA:指定のプレフィックス配下のオブジェクトに対するすべてのメタデータ更新を含みます。

    • DELETE:指定のプレフィックス配下のオブジェクトに対する DeleteObject、DeleteMultipleObjects、バージョニングが有効な場合の削除マーカーの作成、ライフサイクルに基づく削除などのすべての削除操作を含みます。 削除には、削除マーカーの作成またはオブジェクトの完全な削除のいずれかが含まれます。 完全な削除の場合、レコードはBucketKeySequenceNumberRecordTypeRecordTimestamp、およびVersionIdのみのコアフィールドを保持します。 他のすべての列は null です。

  • RecordTimestamp :タイムスタンプはグリニッジ標準時 (GMT) で、ミリ秒単位まで正確です。 例: "2024-08-25 18:08:01.024"。

  • Requester :リクエスタの Alibaba Cloud ID またはプリンシパル ID。

  • RequestId :リクエストの一意の識別子。

  • SourceIp :リクエスタの送信元 IP アドレス。

  • Key :バケット内のオブジェクトの名前で、URL エンコードされています。

  • VersionId :オブジェクトのバージョン ID。 このフィールドは、インベントリルールですべてのバージョンをエクスポートするように設定されている場合にのみ含まれます。

    • バケットでバージョニングが有効になっていない場合、このフィールドは空です。

    • バケットでバージョニングが有効になっている場合、このフィールドにはオブジェクトのバージョン ID が含まれます。

  • IsDeleteMarker :オブジェクトのバージョンが削除マーカーであるかどうかを示します。 このフィールドは、インベントリルールですべてのバージョンをエクスポートするように設定されている場合にのみ含まれます。

    • バケットでバージョニングが有効になっていない場合、このフィールドはデフォルトでfalseになります。

    • バケットでバージョニングが有効になっている場合、このフィールドは削除マーカーの場合はtrue、それ以外の場合はfalseになります。

  • Size :オブジェクトのサイズ。

  • StorageClass :オブジェクトのストレージクラス。

  • LastModifiedDate :オブジェクトの最終更新日時。

  • ETag :オブジェクトの ETag。 ETag は、オブジェクトのコンテンツを識別するためにオブジェクトの作成時に生成されます。

    • PutObject API を使用して作成したオブジェクトの場合、ETag はオブジェクトコンテンツの MD5 ハッシュです。

    • 他の方法で作成したオブジェクトの場合、ETag は特定のルールに基づいて生成された一意の値であり、オブジェクトコンテンツの MD5 ハッシュではありません。

  • IsMultipartUploaded :オブジェクトがマルチパートアップロードを使用してアップロードされたかどうかを示します。

  • ObjectType :オブジェクトタイプ。

  • ObjectAcl :オブジェクトの読み取りおよび書き込み権限。

  • Crc64 :オブジェクトの CRC64。

  • EncryptionStatus :オブジェクトが暗号化されているかどうかを示します。

  • リクエスト例

    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 CLI

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