- HOME
- 開発者ガイドブック(APIリファレンス)
- オブジェクトストレージ
- サービス操作
- バケット操作
- List Multipart Upload
List Multipart Upload
処理概要
バケット内のオブジェクトリスト(objectは1000エントリまで)を返します。markerを使って1001エントリ以降を取得できます。
指定bucketのオブジェクトリストの一部を返すリクエストパラメータを使用できます。200 OKのレスポンスのなかには、有効または無効なXMLが含まれています。
リクエスト
リクエストパラメータ
このGETの操作はバケットのオブジェクトリストの一部を返す次の表のリクエストパラメータを使用します。
| Parameter | Type | Description | Required |
|---|---|---|---|
| delimiter | string | デリミタ文字です。 | No |
| encoding-type | string | レスポンスをエンコードするために要求し、使用するエンコード方式を指定します。 | No |
| max-uploads | integer | マルチパートアップロードリストの最大値を設定します。1~1,000までを指定します。レスポンスは最大1,000返す事ができます。 | No |
| key-marker | string | リストの開始位置として、upload-id-markerと一緒にこのパラメタを指定します。 | No |
| prefix | string | 指定した接頭辞から始まるキーのみを選択します。接頭辞を使うことで、別のグループ化キーと区別することができます(ファイルシステムでのフォルダのよう に、接頭辞を使ってキーをグループ化することもできます)。 | No |
| upload-id-marker | string | リストの開始位置として、key-markerと一緒にこのパラメタを指定します。もしkey-markerが無指定だった場合、upload-id-markerは無視されます。それ以外の場合は、key-markerに等しいキーのための任意のマルチパートアップロードは、指定されたupload-id-markerより辞書式順序において大きいアップロードIDを持っている場合にのみ、リストに含まれることがあります。 | No |
リクエストヘッダー
このオペレーションはすべての操作に共通するリクエストヘッダのみを使用しています。詳細については、一般的なリクエストヘッダを参照してください。
リクエストボディ
なし
リクエストサンプル
GET /sample-bucket HTTP/1.1 Host: 192.168.0.1 Date: Tue, 01 Sep 2015 10:00:00 +0000 Authorization: AWS EXAMPLEjU2So5By3H5v2:EXAMPLEAjwlAvEi2cPLfQaM588ROWW90so7LwfPr
レスポンス
レスポンスヘッダー
このオペレーションはすべての操作に共通するレスポンスヘッダのみを使用しています。詳細については、一般的なレスポンスヘッダを参照してください。
レスポンスボディ
| Name | Type | Description |
|---|---|---|
| ListMultipartUploadsResult | container | レスポンスのコンテナ |
| Bucket | string | 開始されているマルチパートアップロードのbucket名 |
| KeyMarker | string | リスト開始位置のキー名 |
| UploadIdMarker | string | リスト開始位置のアップロードID |
| NextKeyMarker | string | リストが切断されている時、後続のkey-markerリクエストパラメタで利用できる値が指定される。 |
| NextUploadIdMarker | string | リストが切断されている時、後続のupload-id-markerリクエストパラメタで利用できる値が指定される。 |
| Encoding-Type | string | レスポンスにあるobjectのエンコードタイプ |
| MaxUploads | integer | このレスポンスに含まれるマルチパートアップロードの最大値 |
| IsTruncated | boolean | リストが途中で切断されているかを知るフラグ。MaxUploads要素に書かれた最大値を超えていたら、リストは切断されます。もしリストが切断されていたら、レスポンスに含まれるNextKeyMarker/NextUploadIdMarkerを開始位置(リクエストパラメタのkey-marker, upload-id-marker)とした別のリクエストで切断以降のリストを取得できます。 |
| Upload | container | 特定のマルチパートアップロードに関連したコンテナ。レスポンスに0個以上含まれる要素です。 |
| Key | integer | 開始されているマルチパートアップロードのobjectのキー名 |
| UploadId | integer | 開始されているマルチパートアップロードのアップロードID |
| Initiator | container | マルチパートアップロードを開始したユーザーのコンテナ |
| ID | string | 承認済ユーザーID |
| DisplayName | string | ユーザー名 |
| Owner | container | objectを作成したobjectのオーナーのコンテナ |
| StorageClass | string | マルチパートアップロード完了後に保存されるべきストレージ種別。”STANDARD”のみ。 |
| Initiated | datetime | マルチパートアップロードの開始日時 |
| ListMultipartUploadsResult.Prefix | string | リクエスト時にprefixが与えられていれば、このフィールドはそのprefixを含みます。このprefixで始まるキーだけがレスポンスに含まれる事になります。 |
| Delimiter | string | リクエスト時に指定されたデリミタ。もしリクエスト時に何も指定していなければ、レスポンス時にはこの要素は出現しない。 |
| CommonPrefixes | container | リクエスト時にデリミタを指定していれば、CommonPrefixs要素には個々のkey prefixはデリミタを含みます。個々のkey prefixはPrefixの子要素で確認できます。 |
| CommonPrefixes.Prefix | string | Prefixを含めずにリクエストした場合、デリミタ文字が最初に出現する位置までをprefixとして表示する。それらのキーはレスポンスのどこにも返されない。 |
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Contents>
<ETag>string</ETag>
<Owner>
<ID>string</ID>
<DisplayName>string</DisplayName>
</Owner>
<Key>string</Key>
<Size>string</Size>
<StorageClass>string</StorageClass>
</Contents>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
<Delimiter>string</Delimiter>
<Encoding-Type>string</Encoding-Type>
<IsTruncated>Boolean</IsTruncated>
<LastModified>Date</LastModified>
<Marker>string</Marker>
<MaxKeys>string</MaxKeys>
<Name>string</Name>
<NextMarker>string</NextMarker>
<Prefix>string</Prefix>
</ListBucketResult>
レスポンスサンプル
HTTP/1.1 200 OK Date: Tue, 01 Sep 2015 10:00:00 GMT X-Clv-Request-Id: 01234567-89ab-cdef-0123-456789abcdef Accept-Ranges: bytes Server Cleversafe/3.5.1.0 is not blacklisted Server: Cleversafe/3.5.1.0 X-Clv-S3-Version: 2.4 x-amz-request-id: 01234567-89ab-cdef-0123-456789abcdef Content-Type: application/xml Content-Length: 574
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Name>sample-bucket</Name>
<Prefix></Prefix>
<Marker></Marker>
<MaxKeys>1000</MaxKeys>
<Delimiter></Delimiter>
<IsTruncated>false</IsTruncated>
<Contents>
<Key>sample-object.txt</Key>
<LastModified>2015-09-01T09:00:00.000Z</LastModified>
<ETag>"abcdef0123456789abcdef0123456789"</ETag>
<Size>123</Size>
<Owner>
<ID>56789abc-def0-1234-5678-9abcdef01234</ID>
<DisplayName>abc0001</DisplayName>
</Owner>
<StorageClass>STANDARD</StorageClass>
</Contents>
</ListBucketResult>
