最終更新日:2025-08-18 15:50:06
指定バケット内のオブジェクトを一覧表示する場合、IAM権限 wos:GetBucket が必要です。
GET /?prefix=Prefix&marker=Marker&max-keys=Max-Keys&delimiter=Delimiter&start-time=Start-Time&end-time=End-Time
Host: BucketName.Endpoint
Date: Date
Authorization: <Authorization>
| パラメータ名 | 必須 | 説明 | 型 |
|---|---|---|---|
| prefix | いいえ | 指定したプレフィックスで始まるオブジェクトのみ返却します。ファイルシステムのフォルダのように、オブジェクトをグループ化するために利用可能です。 | String |
| marker | いいえ | オブジェクト一覧開始位置となるキーを指定します。辞書順で並べられます。 | String |
| max-keys | いいえ | 返されるオブジェクトの最大数。リストには最大max-keys個までのオブジェクトが辞書順で含まれます。指定範囲は[1, 1000]です。範囲外の場合はデフォルトで1000になります。 | Integer |
| delimiter | いいえ | オブジェクト名をまとめるための文字。prefixパラメータ指定時は、オブジェクト名はdelimiterで分割され、prefixと最初のdelimiterの間が一致するものがCommonPrefixesにグループ化されます。prefix未指定時は最初のdelimiterまでの名前でグループ分けされます。 | String |
注意: パラメータ名は大文字・小文字を区別します。たとえば
PREFIX=abcでは認識されません(認証計算の際には含まれます)。
common request headers のみご利用ください。
ありません
HTTP/1.1 StatusCode
x-wos-request-id: RequestId
Date: Date
Content-Type: type
Content-Length: length
Server: WS-web-server
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns="https://www.wangsu.com/document">
<IsTruncated>boolean</IsTruncated>
<Marker>string</Marker>
<NextMarker>string</NextMarker>
<Contents>
<ETag>string</ETag>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<ExpirationDate>timestamp</ExpirationDate>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
<Size>integer</Size>
<StorageClass>string</StorageClass>
</Contents>
...
<Name>string</Name>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<MaxKeys>integer</MaxKeys>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
<EncodingType>string</EncodingType>
</ListBucketResult>
common response headers のみご利用ください。
レスポンスはXML形式で返され、指定バケット内のオブジェクト一覧が表示されます。各要素の意味は以下の通りです:
| 要素名 | 説明 | 型 | 親ノード |
|---|---|---|---|
| ListBucketResult | バケット内オブジェクトのリスト。 | XML | - |
| Contents | オブジェクトのメタデータ。 | XML | ListBucketResult |
| CommonPrefixes | 指定delimiterでグループ化されたオブジェクト群。delimiter前まで同じプレフィックスを持つオブジェクトでグループ化されます。 | XML | ListBucketResult |
| Delimiter | リクエストで使用した区切り文字。 | String | ListBucketResult |
| ETag | オブジェクトの、base64エンコードされた128bitのMD5ダイジェスト。この値はオブジェクト内容の一意識別子となり、内容の変更が判別できます。例えばアップロード時のETagとダウンロード時のETagが異なれば内容が異なります。 ETagはオブジェクトハッシュ値であり、メタデータ変更には影響しません。MD5暗号化ごとに固有の値となります。 |
String | ListBucketResult.Contents |
| ID | オブジェクト所有者のユーザーID。 | String | ListBucketResult.Contents.Owner |
| DisplayName | オブジェクト所有者のユーザー名。 | String | ListBucketResult.Contents.Owner |
| IsTruncated | 結果が途中で切られている場合はtrue、完全に返却された場合はfalse。 | Boolean | ListBucketResult |
| Key | オブジェクト名。 | String | ListBucketResult.Contents |
| LastModified | オブジェクトの最終更新時刻。 | Date | ListBucketResult.Contents |
| Marker | オブジェクト一覧開始位置。 | String | ListBucketResult |
| NextMarker | 今回のリストで全てを返し切れていない場合、返却された最後のオブジェクト名。この値を次回のmarkerに指定することで続きが取得可能です。 | String | ListBucketResult |
| MaxKeys | 取得するオブジェクトの最大個数。 | String | ListBucketResult |
| Name | バケット名。 | String | ListBucketResult |
| Owner | ユーザー情報(IDとユーザー名を含む)。 | XML | ListBucketResult.Contents |
| Prefix | オブジェクト名のプレフィックス。この値と一致するオブジェクトのみリストアップされます。 | String | ListBucketResult |
| Size | オブジェクトのサイズ。 | String | ListBucketResult.Contents |
| StorageClass | オブジェクトのストレージクラス。有効値: STANDARD |
Enumeration | ListBucketResult.Contents |
| ExpirationDate | オブジェクトの有効期限。 | Date | ListBucketResult.Contents |
| 状況 | HTTPステータス | エラーコード | メッセージ |
|---|---|---|---|
| max-keysが負の値 | 400 Bad Request | InvalidArgument | max-keys cannot be negative |
| max-keysが小数または整数範囲外 | 400 Bad Request | InvalidArgument | Provided max-keys not an integer or within integer range |