addRoute
    • PDF

    addRoute

    • PDF

    記事の要約

    VPC環境で利用できます。

    ルーティングテーブルにルートを追加します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET、POST/addRoute

    リクエストヘッダ

    VPC APIで共通して使用されるヘッダの詳細は、VPCの共通ヘッダをご参照ください。

    リクエストクエリパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    regionCodeStringOptionalルート追加対象のルーティングテーブルのリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
  • vpcNoStringRequiredルーティングテーブルの VPC番号
  • getVpcListアクションを通じて取得可能
  • routeTableNoStringRequiredルーティングテーブル番号
  • getRouteTableListを通じて確認
  • routeList.N.destinationCidrBlockStringRequired追加するルートの宛先 IPv4アドレスの範囲
  • CIDR表記を使用
  • <例> routeList.1.destinationCidrBlock=0.0.0.0/0&routeList.2.destinationCidrBlock=100.10.20.0/24
  • routeList.N.targetTypeCodeStringRequired追加するルートの宛先タイプ
    • NATGW | VPCPEERING | VGW
      • NATGW: NAT Gateway
      • VPCPEERING: VPC Peering
      • VGW: Virtual Private Gateway
      • <例>routeList.1.targetTypeCode=NATGW&routeList.2.targetTypeCode=VPCPEERING
    routeList.N.targetNoStringRequired追加するルートの宛先識別番号
  • 各宛先タイプに当てはまるリソースリストを照会する APIを通じて確認
  • <例>routeList.1.targetNo=1234&routeList.2.targetNo=2345
  • routeList.N.targetNameStringRequired追加するルートの宛先名
  • 各宛先タイプに当てはまるリソースリストを照会する APIを通じて確認
  • <例>routeList.1.targetName=test-natgateway&routeList.2.targetName=test-peering
    responseFormatTypeStringOptional

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    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をご参照ください。

    レスポンスステータスコード

    NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    <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>
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.