MENU
      getNatGatewayInstanceList

        getNatGatewayInstanceList


        Article summary

        Available in VPC

        View the list of NAT Gateway instances based on the conditions the user specifies.

        Request

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

        MethodURI
        GET, POST/getNatGatewayInstanceList

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionCodeStringOptionalRegion code whose network ACL instance list you want to view
      • First Region of the search result (default)
      • Check through getRegionList
      • zoneCodeStringOptionalZone code whose NAT Gateway instance list you want to view
      • Check through getZoneList
      • natGatewayInstanceNoList.NList<String>OptionalView with the NAT Gateway instance number
      • natGatewayInstanceNo can be obtained through getNatGatewayInstanceList
      • <E.g.> natGatewayInstanceNoList.1=1234&natGatewayInstanceNoList.2=2345
      • publicIpStringOptionalView with the public IP address assigned to the NAT Gateway
        vpcNameStringOptionalView with the VPC name
        natGatewayNameStringOptionalView with the NAT Gateway name
        natGatewayInstanceStatusCodeStringOptionalView with the NAT Gateway instance status code
      • INIT | RUN | TERMTING
      • pageNoIntegerOptionalPage number of the paged results
        • Page the result values using pageNo and pageSize
        pageSizeIntegerConditional
        responseFormatTypeStringOptionalResponse result format
        • xml (default) | json
        subnetNameStringOptionalView with the subnet name
        privateIpStringOptionalView with the private IP address
        natGatewayTypeCodeCommonCodeOptionalView with the NAT Gateway type
        • PRVT | PBLIP
          • PRVT: private NAT Gateway
          • PBLIP: public NAT Gateway
        subnetNoStringOptionalView with the subnet number

        Request example

        The following is a sample request.

        curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getNatGatewayInstanceList
        ?regionCode=KR
        &zoneCode=KR-1
        &natGatewayInstanceNoList.1=***9734
        &publicIp=***.***.109.101
        &vpcName=test-vpc
        &natGatewayName=test-***
        &natGatewayInstanceStatusCode=RUN
        &natGatewayTypeCode=PBLIP'
        --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.

        <getNatGatewayInstanceListResponse>
          <requestId>7d68eb6c-6015-45d1-8711-e5e65d3704c6</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <natGatewayInstanceList>
            <natGatewayInstance>
              <vpcNo>***36</vpcNo>
              <vpcName>test-vpc</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>2023-04-18T15:13:27+0900</createDate>
              <natGatewayDescription></natGatewayDescription>
              <zoneCode>KR-1</zoneCode>
              <natGatewayType>
                 <code>PBLIP</code>
                 <codeName>Public</codeName>
              </natGatewayType>
              <subnetName>v-kr1-pub-natgw-***</subnetName>
              <subnetNo>***28</subnetNo>
              <privateIp>10.0.***.***</privateIp>
              <publicIpInstanceNo>***25</publicIpInstanceNo>
            </natGatewayInstance>
          </natGatewayInstanceList>
        </getNatGatewayInstanceListResponse>
        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.