addRoute
- Print
- PDF
addRoute
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Overview
This adds the route list to the routing table.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region code You can decide the region of the routing table in which a route will be added. regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList search results | |
| vpcNo | Yes | String | VPC number This determines the VPC of the routing table in which a route will be added. vpcNo can be obtained through the getVpcList action. | |
| routeTableNo | Yes | String | Routing table number This determines the number of the routing table in which a route will be added. The routeTableNo can be obtained through the getRouteTableList action. | |
| routeList.N.destinationCidrBlock | Yes | String | Destination IPv4 CIDR block This specifies the destination IP address range of the route to be added. ex) routeList.1.destinationCidrBlock=0.0.0.0/0&routeList.2.destinationCidrBlock=100.10.20.0/24 | |
| routeList.N.targetTypeCode | Yes | String | Destination type code This specifies the destination type of the route to be added. Options : NATGW (NAT Gateway) | VPCPEERING (VPC Peering) | VGW (Virtual Private Gateway) ex) routeList.1.targetTypeCode=NATGW&routeList.2.targetTypeCode=VPCPEERING | |
| routeList.N.targetNo | Yes | String | Destination identification number This determines the destination identification number corresponding to the destination type. The targetNo can be obtained through the query action corresponding to each destination type. ex) routeList.1.targetNo=1234&routeList.2.targetNo=2345 | |
| routeList.N.targetName | Yes | String | Destination name Enter the destination name corresponding to the destination type. The targetName can be obtained through the query action corresponding to each destination type. ex) routeList.1.targetName=test-natgateway&routeList.2.targetName=test-peering | |
| responseFormatType | No | String | Format type of the response results Options : xml | json Default : xml |
Response
Response body
Example
Request Example
GET {API_URL}/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-***
Response Example
The route list of the corresponding routing table after completing the request
<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>
Was this article helpful?