getCloudMongoDbTargetVpcList
- 印刷する
- PDF
getCloudMongoDbTargetVpcList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
Cloud DB for MongoDBで使用可能な VPCリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET, POST | /getCloudMongoDbTargetVpcList |
リクエストヘッダ
Cloud DB for MongoDB (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MongoDB (VPC)のリクエストヘッダをご参照ください。
リクエストパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode | String | Optional | 照会対象の VPCのリージョンコード
|
responseFormatType | String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/getCloudMongoDbTargetVpcList
?regionCode=KR
&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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、TargetVpcListをご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
responseFormetType=json
の場合{ "getCloudMongoDbTargetVpcListResponse": { "totalRows": 1, "targetVpcList": [ { "vpcNo": "59***", "vpcName": "***-vpc", "ipv4Cidr": "10.0.0.0/16", "regionCode": "KR", "createdDate": "2024-03-28T13:40:23+0900" } ], "requestId": "8764a045-****-****-****-9643b69c37e1", "returnCode": "0", "returnMessage": "success" } }
responseFormetType=xml
(デフォルト)の場合<?xml version="1.0" encoding="UTF-8"?> <getCloudMongoDbTargetVpcListResponse> <requestId>8764a045-****-****-****-9643b69c37e1</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <totalRows>1</totalRows> <targetVpcList> <targetVpc> <vpcNo>59***</vpcNo> <vpcName>***-vpc</vpcName> <ipv4Cidr>10.0.0.0/16</ipv4Cidr> <regionCode>KR</regionCode> <createdDate>2024-03-28T13:40:23+0900</createdDate> </targetVpc> </targetVpcList> </getCloudMongoDbTargetVpcListResponse>
この記事は役に立ちましたか?