MENU
      setNatGatewayDescription

        setNatGatewayDescription


        Article summary

        Available in VPC

        Edit the NAT Gateway instance description by specifying the NAT Gateway instance number.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        GET, POST/setNatGatewayDescription

        Request headers

        For headers common to all VPC APIs, see VPC common headers.

        Request query parameters

        The following describes the parameters.

        Parameter nameTypeRequiredDescription
        regionCodeStringOptionalRegion code of the NAT Gateway instance whose description you want to edit
      • First Region of the search result (default)
      • Check through getRegionList
      • natGatewayInstanceNoStringRequiredNumber of the NAT Gateway instance whose description you want to edit
      • Check through getNatGatewayInstanceList
      • natGatewayDescriptionStringOptionalDescription for the NAT Gateway to edit to (byte)
        • 0 - 1000
        responseFormatTypeStringOptionalResponse result format
        • xml (default) | json

        Request example

        The following is a sample request.

        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}'
        Curl

        Response

        The following describes the response format.

        Response body

        See NatGatewayInstanceList 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 following is a sample response.

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

        Was this article helpful?

        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.