setNatGatewayDescription

Prev Next

VPC環境で利用できます。

NAT Gatewayインスタンスの番号を指定して NAT Gatewayインスタンスの説明を変更します。

リクエスト

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

メソッド URI
GET, POST /setNatGatewayDescription

リクエストヘッダ

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

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

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

パラメータ名 タイプ 必須の有無 説明
regionCode String Optional 説明変更対象 NAT Gatewayインスタンスのリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
    		•
    natGatewayInstanceNo String Required 説明変更対象の NAT Gatewayインスタンス番号
  • getNatGatewayInstanceListを通じて確認
    		•
    natGatewayDescription String Optional 変更後の NAT Gatewayの説明 (Byte)
    • 0~1000
    output String Optional レスポンス結果の形式
    • xml | json(デフォルト)

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/setNatGatewayDescription
?regionCode=KR
&natGatewayInstanceNo=***38
&natGatewayDescription=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}'

    レスポンス

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

    レスポンスボディ

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

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

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

    レスポンス例

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

    <setNatGatewayDescriptionResponse>
  <requestId>bbe69135-359f-443a-8a32-d38d590e2c87</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***04</vpcNo>
      <vpcName>test-***</vpcName>
      <natGatewayInstanceNo>***9734</natGatewayInstanceNo>
      <natGatewayName>test-***</natGatewayName>
      <publicIp>***.***.109.101</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Running</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2020-06-24T08:58:20+0900</createDate>
      <natGatewayDescription>test-description</natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
    </natGatewayInstance>
  </natGatewayInstanceList>
</setNatGatewayDescriptionResponse>