Object Storage Service (OSS) バケット内のすべてのオブジェクトに関する情報を一覧表示します。
使用上の注意
GetBucket (ListObjects) 操作は GetBucketV2 (ListObjectsV2) に更新されました。アプリケーションを開発する際は、GetBucketV2 (ListObjectsV2) 操作を呼び出すことをお勧めします。 下位互換性を維持するために、OSS は GetBucket (ListObjects) 操作を引き続きサポートします。 GetBucketV2 (ListObjectsV2) の詳細については、「ListObjectsV2 (GetBucketV2)」をご参照ください。
GetBucket (ListObjects) リクエストでは、オブジェクトのユーザーメタデータは返されません。
GetBucket (ListObjects) 操作はバケットに対して実行されます。 PUT リクエストの料金は、バケットのストレージタイプに基づいて課金されます。 GetBucket (ListObjects) 操作を呼び出すたびに、API 呼び出し料金が発生します。 詳細については、「API 操作の呼び出し料金」をご参照ください。
バケットでバージョン管理が有効になっている場合、上書きまたは誤って削除すると、多数の削除マーカーと履歴バージョンが生成されます。リストのパフォーマンスへの影響を避けるため、不要になった削除マーカーと履歴バージョンを定期的にクリアするライフサイクルルールの設定をお勧めします。
リクエスト構文
GET / HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
リクエストヘッダー
GetBucket (ListObjects) リクエストには、Authorization
や Host
などの共通リクエストヘッダーのみが含まれます。 詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | 種類 | 必須 | 例 | Web アプリを作成する: |
デリミタ | 文字列 | いいえ | / | オブジェクトを名前でグループ化するために使用する文字。リクエストで delimiter パラメーターを指定すると、応答には CommonPrefixes パラメーターが含まれます。プレフィックスからデリミタの次の出現までの同じ文字列を名前に含むオブジェクトは、CommonPrefixes 内の単一の結果要素としてグループ化されます。 デフォルトでは、このパラメーターは空のままです。 |
マーカー | String | いいえ | test1.txt | ListObjects (GetBucket) 操作が開始されるオブジェクトの名前の後に続くオブジェクトの名前です。このパラメーターを指定すると、名前がアルファベット順でマーカーの後にあるオブジェクトが返されます。 マーカー パラメーターは、返されたオブジェクトをページごとにリストするために使用され、マーカーの値は 1,024 バイト未満の長さでなければなりません。 条件付きクエリ中に指定されたマーカーがリストに存在しない場合でも、リストはマーカー パラメーターの値のアルファベット順に続く名前のオブジェクトから開始されます。 デフォルトでは、このパラメーターは空のままです。 |
max-keys | String | いいえ | 200 | 返されるオブジェクトの最大数です。 max-keys パラメーターの設定によりリスト操作を一度に完了できない場合、NextMarker パラメーターが次のリスト操作のマーカーとして応答に含まれます。 有効な値:1 ~ 1000 デフォルト値:100 |
プレフィックス | String | いいえ | fun | リストするオブジェクトの名前のプレフィックス。
リクエストでプレフィックスがディレクトリ名に設定されている場合、名前がこのプレフィックスを含むオブジェクトがリストされます。これには、ディレクトリ内のすべてのオブジェクトとサブディレクトリが含まれます。 プレフィックスが指定され、デリミタがスラッシュ (/) に設定されている場合、ディレクトリ内のオブジェクトのみがリストされます。ディレクトリ内のサブディレクトリの名前は、CommonPrefixes パラメーターで返されます。ただし、サブディレクトリ内のオブジェクトとディレクトリはリストされません。 たとえば、バケットに fun/test.jpg、fun/movie/001.avi、fun/movie/007.avi というオブジェクトが含まれているとします。プレフィックスを fun/ に設定すると、3 つのオブジェクトが返されます。プレフィックスを fun/ に設定し、デリミタをスラッシュ (/) に設定すると、fun/test.jpg と fun/movie/ が返されます。 デフォルトでは、このパラメーターは空のままです。 |
encoding-type | String | いいえ | url | 応答内のオブジェクト名のエンコードタイプです。 デフォルトでは、このパラメーターは空のままです。 有効な値: url 重要 delimiter、marker、prefix、NextMarker、および Key の値は UTF-8 でエンコードされています。 delimiter、marker、prefix、NextMarker、または Key の値に XML 1.0 標準でサポートされていない制御文字が含まれている場合は、encoding-type パラメーターを指定して、応答で値をエンコードできます。 |
レスポンス要素
要素 | タイプ | 例 | 説明 |
ListBucketResult | コンテナー | 該当なし | GetBucket (ListObjects) 操作へのレスポンスを格納するコンテナー。 子ノード: Name、Prefix、Marker、MaxKeys、Delimiter、IsTruncated、NextMarker、および Contents 親ノード: なし |
Name | 文字列 | oss-example | バケットの名前。 親ノード: ListBucketResult |
Prefix | 文字列 | fun/ | 返されたバケットの名前に含まれるプレフィックス。 親ノード: ListBucketResult または CommonPrefixes |
Marker | 文字列 | test1.txt | リスト操作の開始後に続くオブジェクトの名前。 親ノード: ListBucketResult |
MaxKeys | 文字列 | 100 | レスポンスで返されるオブジェクトの最大数。 親ノード: ListBucketResult |
Delimiter | 文字列 | / | オブジェクトを名前でグループ化するために使用される文字。プレフィックスからデリミタの次の出現までの同じ文字列を名前に含むオブジェクトは、CommonPrefixes パラメーターの単一の結果要素としてグループ化されます。 親ノード: ListBucketResult |
EncodingType | 文字列 | url | レスポンス内のオブジェクト名のエンコーディングタイプ。リクエストで encoding-type パラメーターを指定した場合、レスポンス内の次のパラメーターがエンコードされます: Delimiter、Marker、Prefix、NextMarker、および Key。 親ノード: ListBucketResult |
IsTruncated | 列挙文字列 | false | 返された結果が切り捨てられているかどうかを示します。 有効な値: true および false
親ノード: ListBucketResult |
NextMarker | 文字列 | test100.txt | 次のリスト操作の開始位置。 親ノード: ListBucketResult |
Contents | コンテナー | 該当なし | 返された各オブジェクトのメタデータを格納するコンテナー。 親ノード: ListBucketResult |
Key | 文字列 | fun/test.jpg | オブジェクトのキー。 親ノード: ListBucketResult.Contents |
TransitionTime | 時間 | 2024-04-23T07:21:42.000Z | ライフサイクルルールに基づいて、オブジェクトのストレージクラスがコールドアーカイブまたはディープコールドアーカイブに変換された時間。 説明
親ノード: ListBucketResult.Contents |
LastModified | 時間 | 2012-02-24T08:42:32.000Z | オブジェクトの最終更新時刻。 説明
親ノード: ListBucketResult.Contents |
ETag | 文字列 | 5B3C1A2E053D763E1B002CC607C5A0FE1**** | エンティティタグ (ETag)。オブジェクトのコンテンツを識別するために、オブジェクトの作成時に ETag が作成されます。
親ノード: ListBucketResult.Contents |
Type | 文字列 | Normal | オブジェクトのタイプ。有効な値:
|
Size | 文字列 | 344606 | 返されたオブジェクトのサイズ。単位: バイト。 親ノード: ListBucketResult.Contents |
StorageClass | 文字列 | Standard | オブジェクトのストレージクラス。 親ノード: ListBucketResult.Contents |
RestoreInfo | 文字列 | ongoing-request="true" | オブジェクトの復元ステータス。
|
Owner | コンテナー | 該当なし | バケット所有者に関する情報を格納するコンテナー。 子ノード: DisplayName および ID 親ノード: ListBucketResult.Contents |
ID | 文字列 | 0022012**** | バケット所有者のユーザー ID。 親ノード: ListBucketResult.Contents.Owner |
DisplayName | 文字列 | user_example | オブジェクト所有者の名前。 親ノード: ListBucketResult.Contents.Owner |
CommonPrefixes | コンテナー | 該当なし | リクエストで Delimiter が指定されている場合、レスポンスには CommonPrefixes パラメーターが含まれます。プレフィックスからデリミタの次の出現までの同じ文字列を名前に含むオブジェクトは、CommonPrefixes パラメーターの単一の結果要素としてグループ化されます。 親ノード: ListBucketResult |
x-oss-request-id
や Content-Type
などの一般的なレスポンスヘッダーの詳細については、「共通レスポンスヘッダー」をご参照ください。
例
シンプルな ListObjectsV2 (GetBucketV2) 操作のサンプルリクエスト
GET / HTTP/1.1 Host: examplebucket.oss-cn-hangzhou.aliyuncs.com Date: Fri, 24 Feb 2012 08:43:27 GMT Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
サンプルレスポンスの成功例
HTTP/1.1 200 OK x-oss-request-id: 534B371674E88A4D8906**** Date: Fri, 24 Feb 2012 08:43:27 GMT Content-Type: application/xml Content-Length: 1866 Connection: keep-alive Server: AliyunOSS <?xml version="1.0" encoding="UTF-8"?> <ListBucketResult xmlns="http://doc.oss-cn-hangzhou.aliyuncs.com"> <Name>examplebucket</Name> <Prefix></Prefix> <Marker></Marker> <MaxKeys>100</MaxKeys> <Delimiter></Delimiter> <IsTruncated>false</IsTruncated> <Contents> <Key>fun/movie/001.avi</Key> <TransitionTime>2024-04-23T07:21:42.000Z</TransitionTime> <LastModified>2012-02-24T08:43:07.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> <Contents> <Key>fun/movie/007.avi</Key> <LastModified>2012-02-24T08:43:27.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> <Contents> <Key>fun/test.jpg</Key> <LastModified>2012-02-24T08:42:32.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> <Contents> <Key>oss.jpg</Key> <LastModified>2012-02-24T06:07:48.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> </ListBucketResult>
prefix パラメーターを指定したサンプルリクエスト
GET /?prefix=fun HTTP/1.1 Host: examplebucket.oss-cn-hangzhou.aliyuncs.com Date: Fri, 24 Feb 2012 08:43:27 GMT Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
サンプルレスポンスの成功例
HTTP/1.1 200 OK x-oss-request-id: 534B371674E88A4D8906**** Date: Fri, 24 Feb 2012 08:43:27 GMT Content-Type: application/xml Content-Length: 1464 Connection: keep-alive Server: AliyunOSS <?xml version="1.0" encoding="UTF-8"?> <ListBucketResult xmlns="http://doc.oss-cn-hangzhou.aliyuncs.com"> <Name>examplebucket</Name> <Prefix>fun</Prefix> <Marker></Marker> <MaxKeys>100</MaxKeys> <Delimiter></Delimiter> <IsTruncated>false</IsTruncated> <Contents> <Key>fun/movie/001.avi</Key> <LastModified>2012-02-24T08:43:07.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> <Contents> <Key>fun/movie/007.avi</Key> <LastModified>2012-02-24T08:43:27.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> <Contents> <Key>fun/test.jpg</Key> <LastModified>2012-02-24T08:42:32.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> </ListBucketResult>
prefix パラメーターと delimiter パラメーターを指定したサンプルリクエスト
GET /?prefix=fun/&delimiter=/ HTTP/1.1 Host: examplebucket.oss-cn-hangzhou.aliyuncs.com Date: Fri, 24 Feb 2012 08:43:27 GMT Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
サンプルレスポンスの成功例
HTTP/1.1 200 OK x-oss-request-id: 534B371674E88A4D8906**** Date: Fri, 24 Feb 2012 08:43:27 GMT Content-Type: application/xml Content-Length: 712 Connection: keep-alive Server: AliyunOSS <?xml version="1.0" encoding="UTF-8"?> <ListBucketResult xmlns="http://doc.oss-cn-hangzhou.aliyuncs.com"> <Name>examplebucket</Name> <Prefix>fun/</Prefix> <Marker></Marker> <MaxKeys>100</MaxKeys> <Delimiter>/</Delimiter> <IsTruncated>false</IsTruncated> <Contents> <Key>fun/test.jpg</Key> <LastModified>2012-02-24T08:42:32.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> <CommonPrefixes> <Prefix>fun/movie/</Prefix> </CommonPrefixes> </ListBucketResult>
marker パラメーターを指定したサンプルリクエスト
この例では、max-keys パラメーターは 2 に設定されており、これは返されるオブジェクトの最大数が 2 であることを示します。
GET /?max-keys=2&marker=test1.txt HTTP/1.1 Host: examplebucket.oss-cn-shenzhen.aliyuncs.com Accept-Encoding: identity Accept: */* Connection: keep-alive User-Agent: aliyun-sdk-python/2.11.0(Darwin/18.2.0/x86_64;3.4.1) date: Tue, 26 May 2020 08:39:48 GMT authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
サンプルレスポンスの成功例
レスポンスの NextMarker パラメーターは、次のリスト操作のマーカーを示します。
HTTP/1.1 200 OK Server: AliyunOSS Date: Tue, 26 May 2020 08:39:48 GMT Content-Type: application/xml Content-Length: 1032 Connection: keep-alive x-oss-request-id: 5ECCD5D4881816373582xxx x-oss-server-time: 3 <?xml version="1.0" encoding="UTF-8"?> <ListBucketResult> <Name>examplebucket</Name> <Prefix></Prefix> <Marker>test1.txt</Marker> <MaxKeys>2</MaxKeys> <Delimiter></Delimiter> <EncodingType>url</EncodingType> <IsTruncated>true</IsTruncated> <NextMarker>test100.txt</NextMarker> <Contents> <Key>test10.txt</Key> <LastModified>2020-05-26T07:50:18.000Z</LastModified> <ETag>"C4CA4238A0B923820DCC509A6F75****"</ETag> <Type>Normal</Type> <Size>1</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>1305433xxx</ID> <DisplayName>1305433xxx</DisplayName> </Owner> </Contents> <Contents> <Key>test100.txt</Key> <LastModified>2020-05-26T07:50:20.000Z</LastModified> <ETag>"C4CA4238A0B923820DCC509A6F75****"</ETag> <Type>Normal</Type> <Size>1</Size> <StorageClass>Standard</StorageClass> <Owner> <ID>1305433xxx</ID> <DisplayName>1305433xxx</DisplayName> </Owner> </Contents> </ListBucketResult>
アーカイブオブジェクトまたはコールドアーカイブオブジェクトを含む、バケット内のすべてのオブジェクトをリストするサンプルリクエスト
この例では、examplebucket バケットには、次のコールドアーカイブオブジェクトが含まれています:exampleobject1.txt、exampleobject2.txt、exampleobject3.txt。3 つのオブジェクトは次の状態です。
exampleobject1.txt をリストアするための RestoreObject リクエストが送信されていないか、オブジェクトをリストアするために送信された RestoreObject リクエストの期限が切れています。
exampleobject2.txt をリストアするための RestoreObject リクエストが送信され、オブジェクトはリストアされています。
exampleobject3.txt をリストアするための RestoreObject リクエストが送信され、オブジェクトはリストアされています。
サンプルリクエスト
GET / HTTP/1.1 Host: examplebucket.oss-cn-hangzhou.aliyuncs.com Date: Fri, 24 Feb 2012 08:43:27 GMT Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
サンプルレスポンスの成功例
HTTP/1.1 200 OK x-oss-request-id: 534B371674E88A4D8906**** Date: Date: Fri, 24 Feb 2012 08:43:27 GMT Content-Type: application/xml Content-Length: 1866 Connection: keep-alive Server: AliyunOSS <?xml version="1.0" encoding="UTF-8"?> <ListBucketResult xmlns="http://doc.oss-cn-hangzhou.aliyuncs.com"> <Name>examplebucket</Name> <Prefix></Prefix> <Marker></Marker> <MaxKeys></MaxKeys> <Delimiter></Delimiter> <IsTruncated>false</IsTruncated> <Contents> <Key>exampleobject1.txt</Key> <LastModified>2020-06-22T11:42:32.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>ColdArchive</StorageClass> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> <Contents> <Key>exampleobject2.txt</Key> <LastModified>2020-06-22T11:42:32.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <RestoreInfo>ongoing-request="true"</RestoreInfo> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> <Contents> <Key>exampleobject3.txt</Key> <LastModified>2020-06-22T11:42:32.000Z</LastModified> <ETag>"5B3C1A2E053D763E1B002CC607C5A0FE1****"</ETag> <Type>Normal</Type> <Size>344606</Size> <StorageClass>Standard</StorageClass> <RestoreInfo>ongoing-request="false", expiry-date="Thu, 24 Sep 2020 12:40:33 GMT"</RestoreInfo> <Owner> <ID>0022012****</ID> <DisplayName>user-example</DisplayName> </Owner> </Contents> </ListBucketResult>
OSS SDK
次のプログラミング言語用の OSS SDK を使用して、GetBucket (ListObjects) 操作を呼び出すことができます。
ossutil
GetBucket 操作に対応する ossutil コマンドについては、「list-objects (get-bucket)」をご参照ください。
レスポンス要素
エラーコード | HTTP ステータスコード | 説明 |
NoSuchBucket | 404 | リクエストされたバケットが存在しません。リクエストされたバケットの名前が命名規則に準拠しているかどうかを確認してください。 |
AccessDenied | 403 | バケットにアクセスする権限がありません。バケットオーナーと、 |
InvalidArgument | 400 |
|