VPC環境で利用できます。
Cloud DB for MongoDBで使用可能な Object Storageバケットリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET, POST | /getCloudMongoDbBucketList |
リクエストヘッダ
Cloud DB for MongoDB (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MongoDB (VPC)のリクエストヘッダをご参照ください。
リクエストパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode |
String | Optional | 照会対象の Cloud DB for MongoDBインスタンスのリージョンコード
|
cloudMongoDbInstanceNo |
String | Optional | Cloud DB for MongoDBサーバインスタンス番号
|
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/getCloudMongoDbBucketList
?regionCode=KR
&cloudMongoDbInstanceNo=2512****
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、CloudMongoDbBucketListをご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
-
responseFormetType=json
の場合{ "getCloudMongoDbBucketListResponse": { "totalRows": 1, "cloudMongoDbBucketList": [ { "bucketName": "bucket" } ], "requestId": "d7f284a2-****-****-****-6c1c35f9a3df", "returnCode": "0", "returnMessage": "success" } }
-
responseFormetType=xml
(デフォルト)の場合<?xml version="1.0" encoding="UTF-8"?> <getCloudMongoDbBucketListResponse> <requestId>d7f284a2-****-****-****-6c1c35f9a3df</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <totalRows>1</totalRows> <cloudMongoDbBucketList> <cloudMongoDbBucket> <bucketName>bucket</bucketName> </cloudMongoDbBucket> </cloudMongoDbBucketList> </getCloudMongoDbBucketListResponse>