VPC環境で利用できます。
ルーティングテーブルにルートを追加します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | POST | /vpc/v2/addRoute |
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
VPC APIで共通して使用されるヘッダの詳細は、VPCのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | 関連 Subnetリスト追加対象ルーティングテーブルのリージョンコード
|
vpcNo |
String | Required | 関連 Subnetリスト追加対象ルーティングテーブルの VPC番号 |
routeTableNo |
String | Required | 関連 Subnetリスト追加対象ルーティングテーブルの番号 |
subnetNoList.N |
List[String] | Required | 追加対象の関連 Subnet番号リスト
|
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/addRoute
?regionCode=KR
&vpcNo=***04
&routeTableNo=***38
&routeList.1.destinationCidrBlock=***.***.200.0/24
&routeList.1.targetTypeCode=NATGW
&routeList.1.targetNo=***9734
&routeList.1.targetName=test-***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、RouteListをご参照ください。
レスポンスステータスコード
VPC APIで共通して使用されるレスポンスステータスコードの詳細は、VPCのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
<addRouteResponse>
<requestId>2b97f2f0-39fc-40f0-9a8d-3eb6d40506e3</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>3</totalRows>
<routeList>
<route>
<destinationCidrBlock>***.***.200.0/24</destinationCidrBlock>
<targetName>test-***</targetName>
<routeTableNo>***38</routeTableNo>
<targetType>
<code>NATGW</code>
<codeName>NAT Gateway</codeName>
</targetType>
<targetNo>***9734</targetNo>
<isDefault>false</isDefault>
</route>
<route>
<destinationCidrBlock>***.***.0.0/16</destinationCidrBlock>
<targetName>LOCAL</targetName>
<routeTableNo>***38</routeTableNo>
<targetType>
<code>LOCAL</code>
<codeName>Local</codeName>
</targetType>
<targetNo></targetNo>
<isDefault>true</isDefault>
</route>
<route>
<destinationCidrBlock>***.***.0.0/0</destinationCidrBlock>
<targetName>INTERNET GATEWAY</targetName>
<routeTableNo>***38</routeTableNo>
<targetType>
<code>IGW</code>
<codeName>Internet Gateway</codeName>
</targetType>
<targetNo></targetNo>
<isDefault>true</isDefault>
</route>
</routeList>
</addRouteResponse>