Available in VPC
Get an Object Storage bucket available for exporting and importing files.
Note
- It must be called after subscribing to the Object Storage service and creating a bucket for it to work properly.
- If calling from a sub account, Object Storage service usage permissions may be required.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v1/storage/get-bucket-list |
Request headers
For information about the headers common to all Cloud Data Box APIs, see Cloud Data Box request headers.
Request example
The request example is as follows:
curl --location --request GET 'https://databox.apigw.ntruss.com/api/v1/storage/get-bucket-list' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
totalCount |
Integer | - | Number of response results |
content |
Array | - | List of bucket names |
Response status codes
For information about the HTTP status codes common to all Cloud Data Box APIs, see Cloud Data Box response status codes.
Response example
The response example is as follows:
{
"totalCount": 2,
"content": [
"bckt111",
"bckt222"
]
}