get-bucket-list
- 印刷する
- PDF
get-bucket-list
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Data Box Frameの持ち込み/持ち出し時に使用する bucketリストを照会します。
- APIを使用するには Object Storageのご利用の申し込み後にバケットを作成します。
- Sub Accountの利用時に Object Storageの権限が必要です。
GET https://{endpoint}/bucket/get-bucket-list
レスポンス
| HTTPステータスコード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | リクエスト情報エラー |
| 401 | 認証失敗 |
| 403 | リクエスト情報に対する権限なし |
| 404 | リソースが存在しない |
| 500 | サーバエラー |
例
リクエスト例
https://databoxframe.apigw.ntruss.com/api/v1/bucket/get-bucket-list
レスポンス例
{
"totalCount": 4,
"content": [
{
"disabled": false,
"bucketName": "bucket1"
},
{
"disabled": false,
"bucketName": "bucket2"
},
{
"disabled": false,
"bucketName": "bucket3"
},
{
"disabled": false,
"bucketName": "bucket4"
}
]
}
プロパティ
| 項目 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| totalCount | Yes | Integer | Bucketの総数 | |
| disabled | Yes | Boolean | 使用可否(使用可能: false、使用不可: true) | |
| bucketName | Yes | String | Bucket名 |
エラーコード
| HTTP Status Code | リターンコード | 説明 |
|---|---|---|
| 200 | - | 一般的なリクエスト成功 |
| 400 | 10001, 130*** | リクエスト情報とパラメータエラー |
| 403 | 10002 | リクエスト情報に対する権限なし |
| 404 | 10009 | リソースが存在しない |
| 500 | 130000 | サービス内部エラー |
| 500 | 139999 | 連携サービス APIの呼び出しエラー |
この記事は役に立ちましたか?