getNatGatewayInstanceDetail
    • PDF

    getNatGatewayInstanceDetail

    • PDF

    Article Summary

    Can be used in a VPC environment.

    Overview

    This searches the NAT gateway instance details using the NAT gateway instance number.

    Request

    Request parameters

    Parameter nameRequiredTypeRestrictionsDescription
    regionCodeNoStringRegion code
    You can decide the region in which the NAT Gateway instance details will be queried.
    regionCode can be obtained through the getRegionList action.
    Default: Select the first region of the getRegionList search results
    natGatewayInstanceNoYesStringThe number of the NAT Gateway instance to be queried
    natGatewayInstanceNo can be obtained through the getNatGatewayInstanceList action.
    responseFormatTypeNoStringFormat type of the response results
    Options : xml | json
    Default : xml

    Response

    Response body

    Example

    Request Example

    GET {API_URL}/vpc/v2/getNatGatewayInstanceDetail
    ?regionCode=KR
    &natGatewayInstanceNo=***9734
    

    Response Example

    <getNatGatewayInstanceDetailResponse>
      <requestId>f692e1b8-b15b-4c39-8911-150263abf71b</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-08-06T11:47:40+0900</createDate>
          <natGatewayDescription></natGatewayDescription>
          <zoneCode>KR-1</zoneCode>
        </natGatewayInstance>
      </natGatewayInstanceList>
    </getNatGatewayInstanceDetailResponse>
    

    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.