ListBuckets (GetService) - すべてのバケットを一覧表示 | OSS API - Object Storage Service

注意事項

Object Storage Service (OSS) のバケットを一覧表示するには、oss:ListBuckets 権限が必要です。

詳細については、「カスタムポリシーの付与」をご参照ください。

リクエスト構文

GET / HTTP/1.1
Host: oss.example.com
Date: GMT Date
Authorization: SignatureValue

リクエストヘッダー

ヘッダー

型

必須

例

説明

x-oss-resource-group-id

String

No

rg-aek27tc********

リソースグループの ID です。

リソースグループ ID を指定すると、そのリソースグループ内のバケットが返されます。

rg-default-id を指定すると、デフォルトリソースグループ内のバケットが返されます。
値を指定しない場合、デフォルトリソースグループ内のバケットが返されます。
このヘッダーを省略した場合、Alibaba Cloud アカウントが所有するすべてのバケットが返されます。

リソースグループ ID は、リソース管理コンソールから、または ListResourceGroups を呼び出して取得します。詳細については、「リソースグループの表示」および「ListResourceGroups」をご参照ください。

ListBuckets (GetService) リクエストに含まれる Host や Date などの他の共通リクエストヘッダーの詳細については、「共通リクエストヘッダー」をご参照ください。

リクエストパラメーター

パラメーター	型	必須	例	説明
prefix	String	No	my	返されるバケット名に含めるプレフィックスです。このパラメーターが指定されていない場合、プレフィックスによるフィルタリングは行われません。デフォルト値：空
marker	String	No	mybucket10	一覧表示を開始するバケット名です。この値より後のアルファベット順のバケットが返されます。このパラメーターが指定されていない場合、一覧表示は先頭から開始されます。デフォルト値：空
max-keys	Integer	No	10	返されるバケットの最大数です。有効な値：1～1000 デフォルト値：100

レスポンスヘッダー

ListBuckets (GetService) リクエストへのレスポンスに含まれるすべてのヘッダーは共通レスポンスヘッダーです。詳細については、「共通レスポンスヘッダー」をご参照ください。

レスポンス要素

説明

すべてのバケットが返される場合、ListBuckets (GetService) レスポンス XML では Prefix、Marker、MaxKeys、IsTruncated、および NextMarker が省略されます。

要素	型	例	説明
ListAllMyBucketsResult	コンテナ	N/A	ListBuckets (GetService) の結果のルートコンテナです。子ノード：Owner および Buckets 親ノード：なし
Prefix	String	my	返されるバケットをフィルタリングするために使用するプレフィックスです。親ノード：ListAllMyBucketsResult
Marker	String	mybucket	ListBuckets (GetService)リクエストで指定された、一覧表示の開始位置を示すマーカーです。親ノード：ListAllMyBucketsResult
MaxKeys	String	10	返されるバケットの最大数です。親ノード：ListAllMyBucketsResult
IsTruncated	文字列	true	すべての結果が返されたかどうかを示します。有効な値： true：すべての結果が返されたわけではありません。 false：すべての結果が返されました。親ノード：ListAllMyBucketsResult
NextMarker	String	mybucket10	残りの結果を取得するためのページネーションマーカーです。親ノード：ListAllMyBucketsResult
Owner	コンテナ	N/A	バケット所有者の詳細情報を格納するコンテナです。親ノード：ListAllMyBucketsResult
ID	String	ut_test_put_bucket	バケット所有者のユーザー ID です。親ノード：ListAllMyBucketsResult.Owner
DisplayName	String	ut_test_put_bucket	バケット所有者の表示名です。ユーザー ID と同じです。親ノード：ListAllMyBucketsResult.Owner
Buckets	コンテナ	N/A	複数のバケットエントリを格納するコンテナです。子ノード：Bucket 親ノード：ListAllMyBucketsResult
Bucket	コンテナ	N/A	個々のバケットの詳細情報を格納するコンテナです。子ノード：Name、CreationDate、および Location 親ノード：ListAllMyBucketsResult.Buckets
Name	String	mybucket01	バケットの名前です。親ノード：ListAllMyBucketsResult.Buckets.Bucket
CreationDate	Time	2014-05-15T11:18:32.000Z	バケットが作成された時刻です。フォーマット：`yyyy-mm-ddThh:mm:ss.timezone` 親ノード：ListAllMyBucketsResult.Buckets.Bucket
Location	String	oss-cn-hangzhou	OSS リージョン ID です。親ノード：ListAllMyBucketsResult.Buckets.Bucket
ExtranetEndpoint	String	oss-cn-hangzhou.aliyuncs.com	バケットのパブリックエンドポイントです。親ノード：ListAllMyBucketsResult.Buckets.Bucket
IntranetEndpoint	String	oss-cn-hangzhou-internal.aliyuncs.com	バケットの内部エンドポイントです。親ノード：ListAllMyBucketsResult.Buckets.Bucket
Region	String	cn-hangzhou	Alibaba Cloud リージョン ID です。親ノード：ListAllMyBucketsResult.Buckets.Bucket
StorageClass	String	Standard	バケットのストレージクラスです。有効な値：Standard、IA、Archive、ColdArchive、および DeepColdArchive 親ノード：ListAllMyBucketsResult.Buckets.Bucket
ResourceGroupId	String	rg-aek27tc********	バケットのリソースグループ ID です。デフォルトリソースグループ内のバケットの場合、rg-default-id が返されます。親ノード：ListAllMyBucketsResult.Buckets.Bucket

例

アカウント内のすべてのバケットを一覧表示

リクエスト例

GET / HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

レスポンス例

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-Type: application/xml
Content-Length: 556
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Owner>
    <ID>512**</ID>
    <DisplayName>51264</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-02-17T18:12:43.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-shanghai.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-shanghai-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-shanghai</Location>
      <Name>app-base-oss</Name>
      <Region>cn-shanghai</Region>
      <StorageClass>Standard</StorageClass>
    </Bucket>
    <Bucket>
      <CreationDate>2014-02-25T11:21:04.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-hangzhou</Location>
      <Name>mybucket</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>IA</StorageClass>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

プレフィックスと max-keys を使用したバケットの一覧表示

リクエスト例

GET /?prefix=my&max-keys=10 HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

レスポンス例

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-Type: application/xml
Content-Length: 545
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Prefix>my</Prefix>
  <Marker>mybucket</Marker>
  <MaxKeys>10</MaxKeys>
  <IsTruncated>true</IsTruncated>
  <NextMarker>mybucket10</NextMarker>
  <Owner>
    <ID>ut_test_put_bucket</ID>
    <DisplayName>ut_test_put_bucket</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-05-14T11:18:32.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-hangzhou</Location>
      <Name>mybucket01</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>Standard</StorageClass>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

特定のリソースグループ内のバケットを一覧表示

リクエスト例

GET / HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
x-oss-resource-group-id: rg-aek27tc********

レスポンス例

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-Type: application/xml
Content-Length: 556
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Owner>
    <ID>512**</ID>
    <DisplayName>51264</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-02-07T18:12:43.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-shanghai.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-shanghai-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-shanghai</Location>
      <Name>test-bucket-1</Name>
      <Region>cn-shanghai</Region>
      <StorageClass>Standard</StorageClass>
      <ResourceGroupId>rg-aek27tc********</ResourceGroupId>
    </Bucket>
    <Bucket>
      <CreationDate>2014-02-05T11:21:04.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-hangzhou</Location>
      <Name>test-bucket-2</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>IA</StorageClass>
      <ResourceGroupId>rg-aek27tc********</ResourceGroupId>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

デフォルトリソースグループ内のバケットを一覧表示

リクエスト例

GET / HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
x-oss-resource-group-id: rg-default-id

レスポンス例

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-Type: application/xml
Content-Length: 556
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Owner>
    <ID>512**</ID>
    <DisplayName>51264</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-02-07T18:12:43.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-shanghai.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-shanghai-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-shanghai</Location>
      <Name>test-bucket-3</Name>
      <Region>cn-shanghai</Region>
      <StorageClass>Standard</StorageClass>
      <ResourceGroupId>rg-default-id</ResourceGroupId>
    </Bucket>
    <Bucket>
      <CreationDate>2014-02-05T11:21:04.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-hangzhou</Location>
      <Name>test-bucket-4</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>IA</StorageClass>
      <ResourceGroupId>rg-default-id</ResourceGroupId>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

SDK

ListBuckets (GetService) は、以下のプログラミング言語の OSS SDK を使用して呼び出すことができます。

ossutil

ListBuckets 操作に対応する ossutil コマンドの詳細については、「list-buckets (get-service)」をご参照ください。

エラーコード

エラーコード	HTTP ステータスコード	説明
AccessDenied	403	匿名ユーザーからのリクエストに、ユーザー認証情報が含まれていません。