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

Getting Bucket by Name

You can get information about an Amazon S3 bucket with the specified name.

Request

GET https://<hostname>:4443/v6/S3Resources/buckets/{Name}

Request Headers

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

Request Parameters

The following parameters must be specified in the URL of the request:

Parameter	Type	Description
accountId	string	Specifies the identification number of a cloud account. For more information on how to get this parameter, see Getting Accounts.
RegionType	string	Specifies a region type. The following types are available: Global USGovernment China
Name	string	Specifies the bucket name. For more information on how to get this parameter, see Getting Buckets.

Parameter

Type

Description

accountId

string

Specifies the identification number of a cloud account. For more information on how to get this parameter, see Getting Accounts.

RegionType

string

Specifies a region type. The following types are available:

Global
USGovernment
China

Name

string

Specifies the bucket name. For more information on how to get this parameter, see Getting Buckets.

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

The response body contains the following properties:

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

Example

The example shows how to get information about the Amazon S3 bucket with the specified name that was created by the specified cloud account in the region with the Global region type.

Request:

GET https://abc.tech.local:4443/v6/S3Resources/buckets/Bucket5?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"regionType": "Global",

"regionName": "US East (Ohio)",

"regionId": "us-east-2",

"name": "Bucket5",

"links": {

"self": {

"href": "/v6/S3Resources/buckets/Bucket5?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global&RegionId=us-east-2"

"account": {

"href": "/v6/accounts/c0f030cb-a43a-4713-8da8-717c62a0b4f7"

}