setRouteTableDescription

Prev Next

VPC環境で利用できます。

ルーティングテーブル番号を指定してルーティングテーブルの説明を変更します。

リクエスト

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

メソッド URI
GET | POST /vpc/v2/setRouteTableDescription
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional 説明変更対象ルーティングテーブルのリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを参照
routeTableNo String Required 説明変更対象ルーティングテーブルの番号
routeTableDescription String Optional 変更後のルーティングテーブルの説明 (Byte)
  • 0~1000
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

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

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、RouteTableListをご参照ください。

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

VPC APIで共通して使用されるレスポンスステータスコードの詳細は、VPCのレスポンスステータスコードをご参照ください。

レスポンス例

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

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