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

Object Storage Service:GetBucketInventory

最終更新日:Feb 08, 2026

GetBucketInventory は、バケットの指定されたインベントリタスクの構成を取得します。

注意事項

デフォルトでは、Alibaba Cloud アカウント (root ユーザー) には、バケットのインベントリタスク構成を取得する権限があります。RAM ユーザーまたは Security Token Service (STS) を使用してインベントリタスク構成を取得する場合は、oss:GetBucketInventory 権限が必要です。

リクエスト構文

GET /?inventory&inventoryId=inventoryId HTTP/1.1

リクエストパラメーター

Name

Type

必須

説明

inventoryId

String

はい

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

応答パラメーター

Name

Type

説明

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、TransitionTime、ETag、StorageClass、IsMultipartUploaded、EncryptionStatus、ObjectAcl、TaggingCount、ObjectType、および CRC64

親ノード: OptionalFields

IncrementalInventory

コンテナー

増分インベントリの構成情報。

IsEnabled

ブール値

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

有効な値:

  • true: 有効

  • false: 無効

true に設定すると、トップレベルの IsEnabled パラメーターが false に設定されているかどうかにかかわらず、増分インベントリ機能が有効になります。

親ノード: IncrementalInventory

Schedule

コンテナ

増分インベントリのエクスポート頻度。

親ノード: IncrementalInventory

Frequency

正の整数

増分インベントリのエクスポート頻度 (秒単位)。

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

親ノード: Schedule

OptionalFields

コンテナー

増分インベントリに含める構成フィールド。

親ノード: IncrementalInventory

Field

String

増分インベントリに含める構成フィールド。

親ノード: OptionalFields

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

  • RecordType: イベントタイプ: CREATE、UPDATE_METADATA、または DELETE。

    • CREATE: PutObject、PostObject、AppendObject、MultipartUpload、CopyObject など、選択したプレフィックス下のすべてのアップロード操作。

    • UPDATE_METADATA: 選択したプレフィックス下のすべてのメタデータ更新。

    • DELETE: DeleteObject や DeleteMultipleObjects など、選択したプレフィックス下のすべての削除操作。バージョン管理が有効になっている場合、これには削除マーカーが含まれます。ライフサイクルベースの削除も含まれます。永続的な削除は、BucketKeySequenceNumberRecordTypeRecordTimestamp、および VersionId のコアフィールドのみを記録します。その他のすべての列は null です。

  • RecordTimestamp: "2024-08-25 18:08:01.024" のような ISO 8601 形式のタイムスタンプ。ミリ秒精度でグリニッジ標準時 (GMT) を使用します。

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

  • RequestId: リクエストの一意の ID。

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

  • Key: バケット内のオブジェクトの名前 (URL エンコード済み)。

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

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

    • バケットのバージョン管理が有効になっている場合、このフィールドにはオブジェクトの VersionId が表示されます。

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

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

    • バケットのバージョン管理が有効になっており、オブジェクトが削除マーカーである場合、このフィールドには true が表示されます。オブジェクトが削除マーカーでない場合、このフィールドには false が表示されます。

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

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

  • LastModifiedDate: オブジェクトの最終変更時刻。

  • ETag: オブジェクトのコンテンツを識別するために使用される ETag 値。ETag はオブジェクトが作成されるときに生成されます。

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

    • その他の方法で作成されたオブジェクトの場合、ETag は特定のアルゴリズムによって生成される一意の値ですが、コンテンツの MD5 ハッシュではありません。

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

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

  • ObjectAcl: オブジェクトのアクセス制御リスト (ACL)。

  • CRC64: オブジェクトの CRC-64 チェックサム。

  • 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

この API の SDK は、次のプログラミング言語で利用できます。

ossutil

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