List Multipart Upload

進行中マルチパートアップロードの一覧を返します。
この操作は、 GET Bucket (List Objects) と同様のページング機能をサポートしています。 一度に最大1000個のマルチパートアップロードの一覧を取得し、 key-marker パラメータを指定して次のリストを取得します。 また、一度に取得するマルチパートアップロードの数は max-uploads パラメータで変更することができます。

進行中のマルチパートアップロードとは、 Initiate Multipart Uploadによって開始(初期化)され、完了(Complete Multipart Upload)または中止(Abort Multipart Upload)していないマルチパートアップロードを差します。

 

リクエスト情報

シンタックス
GET /{bucket name}?uploads HTTP/1.1
Host: s3api.iot.iij.jp
Date: {date}
Authorization: {authorization string}

 

リクエストパラメータ

以下のHTTPリクエストパラメータを使用します。


表. List Multipart Uploads リクエストパラメータ一覧
パラメータ名説明必須
delimiter

オブジェクト階層の区切り文字

このパラメータで指定された文字を「階層の区切り文字」として、リクエストで指定したURIに存在するオブジェクトのキーのリストを返します。この時、返されるキーは「階層の区切り文字」で切り捨てられます。具体的な内容については、 GET Bucket の delimiter パラメータについて をご覧ください。

  • 型:String
×
max-uploads

レスポンスに含めるマルチパートアップロードの最大件数

条件に一致するマルチパートアップロードが max-uploadsに満たない場合は、一致する全てのマルチパートアップロードを返します。また、 max-uploads より多くのマルチパートアップロードが一致した場合は、レスポンスエレメントの IsTruncated に真をセットし、 max-uploads の件数分のマルチパートアップロードを辞書順に先頭から選択し返します。

  • 型:Integer
  • デフォルト値:1000
×
key-marker

リストの開始位置を指定するオブジェクトキーのマーカー文字列

リストされたキーのうち、オブジェクトキーを辞書順で並べた際に、ここで指定されたオブジェクトキーより後のもののみをリストに含めます(指定文字列と同名のキーは含まれません)。

  • 型:String
×
prefix

レスポンスに含めるオブジェクトキーを前方一致でフィルタする為の文字列

URI(バケット名指定がURI形式の場合、バケット名より後ろ)の文字列に対して前方一致のフィルタを行います。

  • 型:String
×
upload-id-marker

リストの開始位置を指定するアップロードIDのマーカー文字列

key-marker と同時に使用した場合、アップロードIDを辞書順で並べてこの指定値より後のマルチパートアップロードをリストに含めます。(指定文字列と同名のアップロードIDは含まれません)。 key-marker の指定が無い場合には、 upload-id-marker は無視されます。

  • 型:String
×
リクエストヘッダー

この操作では基本リクエストヘッダーのみ使用します。

リクエストエレメント

この操作ではリクエストエレメントは使用しません。

 

レスポンス情報

レスポンスヘッダー

この操作では基本レスポンスヘッダーのみ返します。

レスポンスエレメント

この操作では以下のレスポンスエレメントを返します。

 

表. List Multipart Uploads レスポンスレメント一覧

名前説明
ploadsResult

レスポンスのルート要素となるコンテナ

  • 型:Container
  • 親:なし
Bucket

マルチパートアップロードの開始時に指定したバケット名

  • 型:String
  • 親:ListMultipartUploadsResult
KeyMarker

リストの開始位置を指定するオブジェクトキーのマーカー文字列

リクエストで key-marker に指定した値です。オブジェクトのキーが(アルファベット順で)これより後のオブジェクトのみリストに含めます。

  • 型:String
  • 親:ListMultipartUploadsResult
UploadIdMarker

リストの開始位置を指定するアップロードIDのマーカー文字列

リクエストで upload-id-marker に指定した値です。

  • 型:String
  • 親:ListMultipartUploadsResult
NextKeyMarker

レスポンスに含まれるマルチパートアップロードのリストが部分的なものだった場合に、ページングで次の一覧の開始位置を指定するオブジェクトキーのマーカー文字列

  • 型:String
  • 親:ListMultipartUploadsResult
NextUploadIdMarker

レスポンスに含まれるマルチパートアップロードのリストが部分的なものだった場合に、ページングで次の一覧の開始位置を指定するアップロードIDのマーカー文字列

  • 型:String
  • 親:ListMultipartUploadsResult
MaxUploads

レスポンスに含まれるマルチパートアップロードのリストの最大件数

リクエストで max-keys に指定した値です。

  • 型:Integer
  • 親:ListMultipartUploadsResult
IsTruncated

マルチパートアップロードの一覧が部分的なものかどうか

この値が true の場合、レスポンスに含まれるマルチパートアップロードの一覧は部分的なものであり、 MaxUploads 以上に存在することを意味します。以降の結果を取得するには、 NextKeyMarker および UploadIdMarker を使用して再び List Multipart Upload をリクエストしてください。

  • 型:Boolean
  • 親:ListMultipartUploadsResult
Upload

マルチパートアップロードに関連する要素を含むコンテナ

  • 型:String
  • 親:ListMultipartUploadsResult
Key

マルチパートアップロード開始時に指定したオブジェクトキー

  • 型:String
  • 親:Upload
UploadId

マルチパートアップロードの識別子

  • 型:String
  • 親:Upload
Initiator

マルチパートアップロードを開始したユーザ情報を含むコンテナ

  • 型:Container
  • 親:Upload
ID

アカウントの識別ID

  • 型:Container
  • 親:Initiator, Owner
DisplayName

アカウントの表示名

  • 型:Container
  • 親:Initiator, Owner
Owner

オブジェクト所有者の情報を含むコンテナ

  • 型:Container
  • 親:Upload
StorageClass

ストレージのクラス本サービスでは常に STANDARD を返します。

  • 型:String
  • 親:Upload
Initiated

マルチパートアップロードの開始日時

  • 型:Date
  • 親:Upload
ListMultipartUploadsResult.Prefix

オブジェクトのキーを前方一致でフィルタリングする文字列

  • 型:String
  • 親:ListMultipartUploadsResult
Delimiter

リクエストでデリミタに指定した値

  • 型:String
  • 親:ListBucketResult
CommonPrefixes

Prefix 直下の仮想的なサブディレクトリのリストを持つコンテナ

リクエストで Prefix および delimiter を指定した場合にのみ含まれます。

  • 型:Container
  • 子:CommonPrefixes.Prefix
  • 親:ListMultipartUploadsResult
CommonPrefixes.Prefix

Prefix 直下の仮想的なサブディレクトリのリストを持つコンテナ

リクエストで Prefix および delimiter を指定した場合にのみ含まれます。

  • 型:Container
  • 子:Prefix
  • 親:CommonPrefixes
エラー情報
この操作は共通のエラーレスポンスを返します。詳しくは エラーコード一覧 をご覧ください。

 

サンプル

最大3件のマルチパートアップロードの一覧で取得する

max-uploads パラメータに 3 を指定しリクエストします。

リクエスト
GET /mybucket?uploads&max-uploads=3 HTTP/1.1
Host: s3api.iot.iij.jp
Date: Wed, 1 Oct 2014 00:00:00 GMT
Authorization: IIJGIO 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=
レスポンス

以下のレスポンスでは、進行中のマルチパートアップロードが4件以上存在するため、部分的な一覧( IsTruncated = true )として返ってきています。 また、 my-upload_2.zip として進行中のマルチパートアップロードが2件あるため、 UploadId で辞書順にソートされています。

HTTP/1.1 200 OK
x-iijgio-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran
x-iijgio-request-id: 318BC8BC148832E5
Date: Wed, 1 Oct 2014 00:00:00 GMT
Content-Length: 1330
Connection: keep-alive
Server: s3api.iot.iij.jp

<?xml version="1.0" encoding="UTF-8"?>
<ListMultipartUploadsResult xmlns="http://acs.dag.iijgio.com/doc/2006-03-01/">
  <Bucket>mybucket</Bucket>
  <KeyMarker></KeyMarker>
  <UploadIdMarker></UploadIdMarker>
  <NextKeyMarker></NextKeyMarker>
  <NextUploadIdMarker>y0cHiwKZjrrJZBC3qyClgpfMPjowQTVcbLRFMafoHCnJHAL</NextUploadIdMarker>
  <MaxUploads>3</MaxUploads>
  <IsTruncated>true</IsTruncated>
  <Upload>
    <Key>my-upload_1.zip</Key>
    <UploadId>PEzcwtbrQQU8gFzGDVH3JTm3o2YjPWbYt1ilTp65wUsYJ1C</UploadId>
    <Initiator>
      <ID>3xqvsfypbm4t5yljpydldixooivd46ne</ID>
      <DisplayName>taro@iij.ad.jp</DisplayName>
    </Initiator>
    <Owner>
      <ID>3xqvsfypbm4t5yljpydldixooivd46ne</ID>
      <DisplayName>taro@iij.ad.jp</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2010-11-10T20:48:33.000Z</Initiated>
  </Upload>
  <Upload>
    <Key>my-upload_2.zip</Key>
    <UploadId>9hXi0elgsVDLD0BEswAJmenhjnmQJ5n5iqBz353CNTMZcJy</UploadId>
    <Initiator>
      <ID>3xqvsfypbm4t5yljpydldixooivd46ne</ID>
      <DisplayName>taro@iij.ad.jp</DisplayName>
    </Initiator>
    <Owner>
      <ID>3xqvsfypbm4t5yljpydldixooivd46ne</ID>
      <DisplayName>OwnerDisplayName</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2010-11-10T20:48:33.000Z</Initiated>
  </Upload>
  <Upload>
    <Key>my-upload_2.zip</Key>
    <UploadId>y0cHiwKZjrrJZBC3qyClgpfMPjowQTVcbLRFMafoHCnJHAL</UploadId>
    <Initiator>
      <ID>hciff0ce2w49shhjz61n1q2k6165mp63</ID>
      <DisplayName>jiro@iij.ad.jp</DisplayName>
    </Initiator>
    <Owner>
      <ID>hciff0ce2w49shhjz61n1q2k6165mp63</ID>
      <DisplayName>jiro@iij.ad.jp</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2010-11-10T20:49:33.000Z</Initiated>
  </Upload>
</ListMultipartUploadsResult>