GetBucketInventory API は、バケットの指定のインベントリ設定を返します。
注意事項
デフォルトでは、Alibaba Cloud アカウントの所有者はインベントリ設定を取得できます。 RAM ユーザーとして、または STS トークンを使用してこの操作を実行するには、oss:GetBucketInventory アクセス許可が必要です。
リクエスト構文
GET /?inventory&inventoryId=inventoryId HTTP/1.1
リクエストパラメーター
|
パラメーター |
タイプ |
必須 |
説明 |
|
inventoryId |
string |
はい |
照会するインベントリ設定の ID。 |
レスポンス要素
|
パラメーター |
タイプ |
説明 |
|
Id |
string |
ユーザーが指定したインベントリ設定の名前。 この名前は、バケット内で一意である必要があります。 |
|
IsEnabled |
boolean |
インベントリが有効かどうかを示します。 有効な値: 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
|
|
OptionalFields |
コンテナー |
インベントリに含めるオプションフィールドのコンテナー。 |
|
Field |
string |
インベントリに含めるオプションフィールド。 オプションフィールド: Size、LastModifiedDate、TransitionTime、ETag、StorageClass、IsMultipartUploaded、EncryptionStatus、ObjectAcl、TaggingCount、ObjectType、Crc64 親: OptionalFields |
|
IncrementalInventory |
コンテナー |
増分インベントリ設定のコンテナー。 |
|
IsEnabled |
boolean |
増分インベントリを有効にするかどうかを示します。 有効な値:
このパラメーターが true の場合、親の IsEnabled パラメーターが false であっても増分インベントリは有効になります。 親: IncrementalInventory |
|
Schedule |
コンテナー |
増分インベントリを生成するためのスケジュールのコンテナー。 親: IncrementalInventory |
|
Frequency |
正の整数 |
増分インベントリを生成する頻度 (秒単位)。 現在、システムは 600 秒の固定周期を使用しています。 各周期中に、システムは自動的にディレクトリプレフィックスを作成し、その周期のマニフェストファイルと複数の CSV ファイルを生成します。 カスタムの頻度設定はサポートしていません。 親: Schedule |
|
OptionalFields |
コンテナー |
増分インベントリに含めるオプションフィールドのコンテナー。 親: IncrementalInventory |
|
Field |
string |
増分インベントリに含めるオプションフィールド。 親: 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>
SDK
この操作は、次の SDK で使用できます:
ossutil CLI
対応する ossutil コマンドについては、「get-bucket-inventory」をご参照ください。