This section explains how to get a list of S3-Compatible or IBM object storage buckets.
Request
GET https://<hostname>:4443/v4/S3CompatibleResources/buckets?accountId=<accountId>&ServicePoint=<ServicePoint>&customRegionId=<customRegionId> |
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. |
ServicePoint | string | A service point of the S3 Compatible device or IBM storage. |
customRegionId | string | A region type of object storage. |
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 |
|---|---|---|
servicePoint | string | An endpoint address. |
customRegionId | string | A region identification number. |
name | string | A bucket name |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
Request: GET https://abc.tech.local:4443/v4/S3CompatibleResources/buckets?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&servicePoint=abc.tech.local:9000&customRegionId=us-east-1
Request Header: Authorization: Bearer <Access-Token>
Response: [{ "servicePoint": "abc.tech.local:9000", "customRegionId": "us-east-1", "name": "bucket1", "links": { "self": {"href": "https://abc.tech.local:4443/v4/S3CompatibleResources/buckets/bucket1?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&ServicePoint=172.17.186.13:9000&CustomRegionId=us-east-1"}, "account": {"href": "https://abc.tech.local:4443/v4/accounts/ebacce24-e6a3-494b-b29c-24d0d588f35e"} } }] |
