ListBucketInventory は、バケットのすべてのインベントリ設定を一覧表示します。
注意事項
ListBucketInventory API を呼び出すには、oss:GetBucketInventory アクセス許可が必要です。詳細については、「RAM ユーザーにカスタムポリシーを付与する」をご参照ください。
1 回のリクエストで取得できるインベントリ設定は最大 100 個です。レスポンスが切り捨てられた場合は、レスポンスの NextContinuationToken 値を次のリクエストの continuation-token として使用して、次のページの結果を取得してください。
バケットのインベントリ設定を管理するアクセス許可があることを確認してください。デフォルトでは、バケット所有者のみがこのアクセス許可を持っています。所有者でない場合は、必要なアクセス許可をリクエストしてください。
リクエストの構文
continuation-token を指定する場合
GET /?inventory&continuation-token=xxx HTTP/1.1continuation-token を指定しない場合
GET /?inventory HTTP/1.1
レスポンスの要素
パラメータ | 型 | 説明 |
InventoryConfiguration | コンテナ | インベントリ設定のコンテナです。 |
IsTruncated | Boolean | インベントリ設定のリストが切り捨てられているかどうかを示します。 有効な値:true または false
|
NextContinuationToken | String | レスポンスが切り捨てられている場合 (IsTruncated が true の場合) 、次のリクエストの continuation-token パラメータでこの継続トークンを使用して、次のページの結果を取得してください。 |
Id | String | ユーザーが指定したインベントリ設定の名前です。名前はバケット内で一意である必要があります。 |
IsEnabled | Boolean | インベントリが有効かどうかを示します。 有効な値:true または false
|
Filter | コンテナ | フィルタルールのコンテナです。インベントリには、フィルタに一致するオブジェクトのみが含まれます。 |
Prefix | String | フィルタリングに使用するオブジェクトのプレフィックスです。 親ノード:Filter |
Destination | コンテナ | インベントリ結果の公開先に関する情報のコンテナです。 |
OSSBucketDestination | コンテナ | インベントリレポートの保存先バケットに関する詳細が含まれます。 親ノード:Destination |
Format | String | エクスポートされるインベントリのファイル形式です。 有効な値:CSV 親ノード:OSSBucketDestination |
AccountId | String | インベントリレポートを保存先バケットに書き込む権限を持つアカウントの ID です。 親ノード:OSSBucketDestination |
RoleArn | String | インベントリレポートを保存先バケットに書き込む権限を持つロールの ARN です。 形式: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 暗号化に使用するキーのコンテナです。 親ノード:Encryption |
KeyId | String | KMS キー ID です。 親ノード:SSE-KMS |
Schedule | コンテナ | インベントリエクスポートスケジュールのコンテナです。 |
Frequency | String | インベントリのエクスポート頻度です。 有効な値: 親ノード:Schedule |
DayOfMonth | Integer |
親ノード:Schedule |
AutoDelete | Boolean | 1 回限りのインベントリをエクスポートした後、インベントリ設定を自動的に削除するかどうかを設定します。この要素は、 有効な値:true、false 親ノード:Schedule |
IncludedObjectVersions | String | インベントリに含めるオブジェクトのバージョンを示します。 有効な値:
|
OptionalFields | コンテナ | インベントリに含まれるオプションフィールドのコンテナです。 |
Field | コンテナ | インベントリに含まれるオプションフィールドです。 オプションフィールド: 親ノード:OptionalFields |
IncrementalInventory | コンテナ | 増分インベントリ設定のコンテナです。 |
IsEnabled | Boolean | 増分インベントリを有効にするかどうかを示します。 有効な値:
true の場合、親の IsEnabled が false であっても、増分インベントリは有効になります。 親ノード:IncrementalInventory |
Schedule | コンテナ | 増分インベントリエクスポートスケジュールのコンテナです。 親ノード:IncrementalInventory |
Frequency | Integer | 増分インベントリのエクスポート頻度 (秒単位) です。この値は システムは、600 秒の固定間隔で増分インベントリをエクスポートします。各間隔で、システムは自動的にディレクトリプレフィックスを作成し、マニフェストファイルと複数の CSV ファイルを生成します。カスタム頻度はサポートされていません。 親ノード:Schedule |
OptionalFields | コンテナ | 増分インベントリに含まれるオプションフィールドのコンテナです。 親ノード:IncrementalInventory |
Field | String | 増分インベントリに含まれるフィールドです。 親ノード: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>
SDK
この操作は、以下の SDK を使用して呼び出すことができます。
Ossutil CLI
ossutil を使用してこの操作を実行するには、list-bucket-inventory コマンドをご参照ください。