This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Buckets

In this article

This section explains how to get a list of Amazon S3 buckets.

Request

GET https://<hostname>:4443/v4/S3Resources/buckets?accountId=<accountId>&RegionType=<RegionType>&RegionId=<RegionId>&name=<name>

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be posted as URL.

Parameter	Type	Description
accountId	string	An identification number of the account under which you can connect to object storage.
RegionType	string	A region type of object storage.
RegionId	string	An identification number of the region the bucket belongs to.
name	string	The name of the bucket.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property	Type	Description
regionType	string	Specifies a region type.
name	string	Specifies a bucket name.
location	string	Specifies a bucket location.
region	string	Specifies a bucket region.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Example

Request:

GET https://abc.tech.local:4443/v4/S3Resources/buckets?accountId=2c647a18-d475-49c2-8401-0fe72e787c70&regionType=Global

Request Header:

Authorization: Bearer <Access-Token>

Response:

[

{

"regionType": "Global",

"name": "abor-frankfurt",

"location": "eu-central-1",

"region": "EUFrankfurt",

"links": {

"self": {"href": "https://abc.tech.local:4443/v4/S3Resources/buckets/abor-frankfurt?accountId=2c647a18-d475-49c2-8401-0fe72e787c70&RegionType=Global&Region=EUFrankfurt"},

"account": {"href": "https://abc.tech.local:4443/v4/accounts/2c647a18-d475-49c2-8401-0fe72e787c70"}

}

{

"regionType": "Global",

"name": "abor-stock",

"location": "eu-north-1",

"region": "EUStockholm",

"links": {

"self": {"href": "https://abc.tech.local:4443/v4/S3Resources/buckets/abor-stock?accountId=2c647a18-d475-49c2-8401-0fe72e787c70&RegionType=Global&Region=EUStockholm"},

"account": {"href": "https://abc.tech.local:4443/v4/accounts/2c647a18-d475-49c2-8401-0fe72e787c70"}

}

{

"regionType": "Global",

"name": "aborbucket",

"location": "us-east-1",

"region": "USEastNVirginia",

"links": {

"self": {"href": "https://abc.tech.local:4443/v4/S3Resources/buckets/aborbucket?accountId=2c647a18-d475-49c2-8401-0fe72e787c70&RegionType=Global&Region=USEastNVirginia"},

"account": {"href": "https://abc.tech.local:4443/v4/accounts/2c647a18-d475-49c2-8401-0fe72e787c70"}

}

}]