VPC環境で利用できます。
ファイルの持ち出しと持ち込みに使用可能な Object Storageバケットを照会します。
参考
- 正常に呼び出すには、事前に Object Storageを申し込んでバケットを作成する必要があります。
- サブアカウントから呼び出す場合は、Object Storageサービスの利用権限が必要な場合があります。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/storage/get-bucket-list |
リクエストヘッダ
Cloud Data Box APIで共通して使用されるヘッダの詳細は、Cloud Data Boxのリクエストヘッダをご参照ください。
リクエスト例
リクエストのサンプルコードは次の通りです。
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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
totalCount |
Integer | - | レスポンス結果数 |
content |
Array | - | バケット名リスト |
レスポンスステータスコード
Cloud Data Box APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Data Boxのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"totalCount": 2,
"content": [
"bckt111",
"bckt222"
]
}