getVpcPeeringInstanceList
- 印刷する
- PDF
getVpcPeeringInstanceList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
指定した条件に基づいて VPC Peeringインスタンスリストを照会します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET、POST | /getVpcPeeringInstanceList |
リクエストヘッダ
VPC APIで共通して使用されるヘッダの詳細は、VPCの共通ヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode | String | Optional | VPC Peeringインスタンスリスト照会対象のリージョンコード |
vpcPeeringInstanceNoList.N | List<String> | Optional | VPC Peeringインスタンス番号で照会vpcPeeringInstanceNo はgetVpcPeeringInstanceListを通じて確認 |
sourceVpcName | String | Optional | Peeringをリクエストした VPC名で照会 |
targetVpcName | String | Optional | Peeringを承諾した VPC名で照会 |
vpcPeeringName | String | Optional | VPC Peering名で照会 |
vpcPeeringInstanceStatusCode | String | Optional | VPC Peeringインスタンスの状態コードで照会
|
pageNo | Integer | Optional | ページングされた結果のページ番号
|
pageSize | Integer | Conditional | |
sortedBy | String | Optional | 照会結果のソート基準
|
sortingOrder | String | Optional | sortedBy 利用時の昇順または降順のソートを設定
|
responseFormatType | String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcPeeringInstanceList
?regionCode=KR
&vpcPeeringInstanceNoList.1=***6212
&sourceVpcName=test-***
&targetVpcName=test-***
&vpcPeeringName=test-peering
&vpcPeeringInstanceStatusCode=RUN'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、VpcPeeringInstanceListをご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
<getVpcPeeringInstanceListResponse>
<requestId>d0d25721-3f73-4b76-baf8-63232d5a8351</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<vpcPeeringInstanceList>
<vpcPeeringInstance>
<vpcPeeringInstanceNo>***6212</vpcPeeringInstanceNo>
<vpcPeeringName>test-***</vpcPeeringName>
<regionCode>KR</regionCode>
<createDate>2020-08-05T20:53:16+0900</createDate>
<lastModifyDate>2020-08-05T20:53:16+0900</lastModifyDate>
<vpcPeeringInstanceStatus>
<code>RUN</code>
<codeName>run</codeName>
</vpcPeeringInstanceStatus>
<vpcPeeringInstanceStatusName>Running</vpcPeeringInstanceStatusName>
<vpcPeeringInstanceOperation>
<code>NULL</code>
<codeName>NULL OP</codeName>
</vpcPeeringInstanceOperation>
<sourceVpcNo>***05</sourceVpcNo>
<sourceVpcName>test-***</sourceVpcName>
<sourceVpcIpv4CidrBlock>***.**1.0.0/16</sourceVpcIpv4CidrBlock>
<sourceVpcLoginId>test-***@naver.com</sourceVpcLoginId>
<targetVpcNo>***06</targetVpcNo>
<targetVpcName>test-***</targetVpcName>
<targetVpcIpv4CidrBlock>***.**2.0.0/16</targetVpcIpv4CidrBlock>
<targetVpcLoginId>test-***@naver.com</targetVpcLoginId>
<vpcPeeringDescription></vpcPeeringDescription>
<hasReverseVpcPeering>false</hasReverseVpcPeering>
<isBetweenAccounts>false</isBetweenAccounts>
<reverseVpcPeeringInstanceNo></reverseVpcPeeringInstanceNo>
</vpcPeeringInstance>
</vpcPeeringInstanceList>
</getVpcPeeringInstanceListResponse>
この記事は役に立ちましたか?