get-bucket-list
- Print
- PDF
get-bucket-list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It views the bucket list to be used for importing/exporting Data Box Frame.
- In order to use the API, you must subscribe to Object Storage and then create a bucket.
- It may require Object Storage permission when using a Sub Account.
GET https://{endpoint}/bucket/get-bucket-list
Responses
| HTTP status code | Description |
|---|---|
| 200 | Success |
| 400 | Request information error |
| 401 | Authentication failed |
| 403 | No permission to request information |
| 404 | Resource not found |
| 500 | Server error |
Examples
Request examples
https://databoxframe.apigw.ntruss.com/api/v1/bucket/get-bucket-list
Response examples
{
"totalCount": 4,
"content": [
{
"disabled": false,
"bucketName": "bucket1"
},
{
"disabled": false,
"bucketName": "bucket2"
},
{
"disabled": false,
"bucketName": "bucket3"
},
{
"disabled": false,
"bucketName": "bucket4"
}
]
}
Properties
| Items | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| totalCount | Yes | Integer | Total number of buckets | |
| disabled | Yes | Boolean | Availability (available: false, unavailable: true) | |
| bucketName | Yes | String | Bucket name |
Errors
| HTTP Status Code | Return code | Description |
|---|---|---|
| 200 | - | Successful normal request |
| 400 | 10001, 130*** | Request information and parameter error |
| 403 | 10002 | No permission to request information |
| 404 | 10009 | Resource not found |
| 500 | 130000 | Service internal error |
| 500 | 139999 | Integration service API call error |
Was this article helpful?