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
|
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
|
OptionalFields | コンテナー | インベントリリストに含める構成フィールド。 |
Field | String | インベントリリストに含める構成フィールド。 有効な値: Size、LastModifiedDate、TransitionTime、ETag、StorageClass、IsMultipartUploaded、EncryptionStatus、ObjectAcl、TaggingCount、ObjectType、および CRC64 親ノード: OptionalFields |
IncrementalInventory | コンテナー | 増分インベントリの構成情報。 |
IsEnabled | ブール値 | 増分インベントリを有効にするかどうかを示します。 有効な値:
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
この API の SDK は、次のプログラミング言語で利用できます。
ossutil
GetBucketInventory 操作に対応する ossutil コマンドの詳細については、「get-bucket-inventory」をご参照ください。