get-bucket-list

Available in VPC

Get the list of buckets in the Object Storage service to be used when importing or exporting Datafence.

Note

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/object-storage/get-bucket-list

Request headers

For information about the headers common to all Datafence APIs, see Datafence request headers.

Request example

The request example is as follows:

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/object-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
`name`	String	-	Bucket name
`enableable`	Boolean	-	Bucket availability `true` \| `false` `true`: available `false`: unavailable

Response status codes

For information about the HTTP status codes common to all Datafence APIs, see Datafence API response status codes.

Response example

The response example is as follows:

[
  {
    "name": "bucket-datafence001",
    "enableable": true
  }
]