setRouteTableDescription

Prev Next

Available in VPC

Edit the route table description by specifying a route table number.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET, POST /setRouteTableDescription

Request headers

For information about the headers common to all VPC APIs, see VPC common headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the route table whose description you want to edit
  • First Region of the query result (default)
  • Check through getRegionList.
  • routeTableNo String Required
    routeTableDescription String Optional Description of the route table to edit (byte)
    • 0-1000
    responseFormatType String Optional

    Request example

    The request example is as follows:

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/setRouteTableDescription
    ?regionCode=KR
    &routeTableNo=***38
    &routeTableDescription=test-description'
    --header 'x-ncp-iam-access-key: {Timestamp}'    
    --header 'x-ncp-iam-access-key: {Access Key}' 
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    Response

    This section describes the response format.

    Response body

    See RouteTableList for the response body.

    Response status codes

    For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

    Response example

    The response example is as follows:

    <setRouteTableDescriptionResponse>
      <requestId>514672fb-3ef8-40a3-9c89-f618623519da</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <routeTableList>
        <routeTable>
          <routeTableNo>***38</routeTableNo>
          <routeTableName>test-***</routeTableName>
          <regionCode>KR</regionCode>
          <vpcNo>***04</vpcNo>
          <supportedSubnetType>
            <code>PUBLIC</code>
            <codeName>Public</codeName>
          </supportedSubnetType>
          <isDefault>false</isDefault>
          <routeTableStatus>
            <code>RUN</code>
            <codeName>run</codeName>
          </routeTableStatus>
          <routeTableDescription>test-description</routeTableDescription>
        </routeTable>
      </routeTableList>
    </setRouteTableDescriptionResponse>