You can call this operation to obtain all buckets that you own. The forward slash (/) in the request syntax represents the root directory.

Note The GetService (ListBuckets) operation is valid only for authenticated users.

Request syntax

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

Request parameters

Note When using GetService(ListBuckets), you can set the parameters described in the following table to limit the list of buckets returned so that only specified results are returned.
Parameter Type Required Description
prefix String No Specifies the prefix that returned bucket names must contain. If this parameter is not specified, prefix information is not used to filter the returned buckets.

Default value: null
marker String No Specifies the name of the bucket after which the list begins. If this parameter is not specified, all results are returned.

Default value: null
max-keys Integer No Specifies the maximum number of buckets that can be returned each time. If this parameter is not specified, default value 100 is used. The maximum value is 1000.

Default value: 100

Response elements

Note When all buckets are returned, the returned XML does not contain Prefix, Marker, MaxKeys, IsTruncated, and NextMarker. If some results are not returned, the preceding nodes are added.
Element Type Description
ListAllMyBucketsResult Container Indicates the container used to store results of the GetService request.

Child node: Owner and Buckets

Parent node: none
Prefix String Indicates the prefix that the returned object names must contain.

Parent node: ListAllMyBucketsResult
Marker String Indicates the name of the bucket after which the list begins.

Parent node: ListAllMyBucketsResult
MaxKeys String Indicates the maximum number of buckets returned each time.

Parent node: ListAllMyBucketsResult
IsTruncated Boolean Indicates whether all results have been returned.
Valid values: true and false
  • true indicates that not all results are returned this time.
  • false indicates that all results have been returned this time.

Parent node: ListAllMyBucketsResult
NextMarker String Indicates the marker for the next GetService(ListBuckets) request, which can be used to return the results that are not returned this time.

Parent node: ListAllMyBucketsResult
Owner Container Indicates the container used to store the information about the bucket owner.

Parent node: ListAllMyBucketsResult
ID String Indicates the user ID of the bucket owner.

Parent node: ListAllMyBucketsResult.Owner
DisplayName String Indicates the name of the bucket owner, which is currently the same as the user ID.

Parent node: ListAllMyBucketsResult.Owner
Buckets Container Indicates the container that stores the information about multiple buckets.

Child node: Bucket

Parent node: ListAllMyBucketsResult
Bucket Container Indicates the container used to store the bucket information.

Child node: Name, CreationDate, and Location

Parent node: ListAllMyBucketsResult.Buckets
Name String Indicates the name of the bucket.

Parent node: ListAllMyBucketsResult.Buckets.Bucket
CreateDate Time (Format: yyyy-mm-ddThh:mm:ss.timezone. Example: 2011-12-01T12:27:13.000Z) Indicates the time when the bucket is created.

Parent node: ListAllMyBucketsResult.Buckets.Bucket
Location String Indicates the data center in which the bucket is located.

Parent node: ListAllMyBucketsResult.Buckets.Bucket
ExtranetEndpoint String Indicates the public endpoint used to access the bucket over the Internet.

Parent node: ListAllMyBucketsResult.Buckets.Bucket
IntranetEndpoint String Indicates the internal endpoint used to access the bucket from ECS instances in the same region.

Parent node: ListAllMyBucketsResult.Buckets.Bucket
StorageClass String Indicates the storage class of the bucket. Valid values: Standard, IA, Archive and ColdArchive.

Parent node: ListAllMyBucketsResult.Buckets.Bucket
Comment String Indicates the comments on the bucket.

Parent node: ListAllMyBucketsResult.Buckets.Bucket

Examples

  • Sample request 1 
    GET / HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS nxj7dtlhcyl5hpvnhi:COS3OQkfQPnKmYZTEHYv2******
    Sample response 1 
    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>2015-12-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-12-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>atestleo23</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>IA</StorageClass>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>
  • Sample request 2 
    GET /? prefix=xz02tphky6fjfiuc&max-keys=1 HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS nxj7dtwhcyl5hpvnhi:COS3OQkfQPnKmYZTEHYv2****
    Sample response 2 
    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>xz02tphky6fjfiuc</Prefix>
  <Marker></Marker>
  <MaxKeys>1</MaxKeys>
  <IsTruncated>true</IsTruncated>
  <NextMarker>xz02tphky6fjfiuc0</NextMarker>
  <Owner>
    <ID>ut_test_put_bucket</ID>
    <DisplayName>ut_test_put_bucket</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-05-15T11: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>xz02tphky6fjfiuc0</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>Standard</StorageClass>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

SDKs

The SDKs of the GetService operation for various programming languages are as follows:

Error codes

Error code HTTP status code Description
AccessDenied 403 The error message returned because the request is from anonymous access and includes no user authentication information.