Available in VPC
Get the list of buckets in the Object Storage service to be used when importing or exporting Data Box Frame.
To use the get-bucket-list API, you must first subscribe to the Object Storage service and create a bucket. See the following for how to subscribe and create a bucket.
- Create after subscribing on the NAVER Cloud Platform console: See Object Storage User Guide.
- Create using API: See PutBucket.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v1/bucket/get-bucket-list |
Request headers
For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.
Request example
The request example is as follows:
curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/bucket/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 | - | Bucket list |
content
The following describes content
.
Field | Type | Required | Description |
---|---|---|---|
disabled |
Boolean | - | Bucket availability
|
bucketName |
String | - | Bucket name |
Response status codes
For information about the response status codes common to all Data Box Frame APIs, see Data Box Frame API response status codes.
Response example
The response example is as follows:
{
"totalCount": 1,
"content": [
{
"disabled": false,
"bucketName": "testddfdas"
}
]
}