getPublicIpInstanceList
    • PDF

    getPublicIpInstanceList

    • PDF

    Article Summary

    개요

    공인 IP 인스턴스 리스트 조회

    설명

    공인 IP 인스턴스 리스트를 조회합니다.

    요청 파라미터

    파라미터 명필수 여부타입제약사항설명
    isAssociatedNoBoolean할당된 공인IP, 할당되지 않은 공인IP 조회 가능
    publicIpInstanceNoListNoList중복 불가조회할 공인 IP 인스턴스 번호 리스트
    publicIpListNoStringMin : 5, Max : 15조회할 공인 IP 리스트
    searchFilterNameNoString공인 아이피(publicIp) | 할당된 서버 명(associatedServerName)
    searchFilterValueNoString조회할 값
    regionNoNoString입력 가능한 상태는 getRegionList 액션을 통해서 획득 가능
    zoneNoNoString공인 IP 인스턴스 리스트를 ZONE을 이용해 필터링 가능
    필터를 설정하지 않으면 해당 리전의 ZONE에 속한 공인 IP 리스트가 모두 선택됨
    pageNoNoIntegerMin : 0, Max : 2147483647건수가 많을 경우 페이지 사이즈에 해당하는 페이지 번호
    pageSizeNoIntegerMin : 0, Max : 2147483647한 페이지에서 조회할 페이지 사이즈
    sortedByNoString목록 결과에 대한 정렬 컬럼을 정할 수 있음
    공인 IP(publicIp) | 공인 IP 인스턴스 번호(publicIpInstanceNo) [대소문자 구분 없음]
    Default : 공인 IP 인스턴스 번호(publicIpInstanceNo)
    sortingOrderNoString오름차순 내림차순에 대한 목록 결과에 ordering을 정할 수 있음
    오름차순(ascending) | 내림차순(descending) [대소문자 구분 없음]
    Default : 오름차순(ascending)

    응답 데이터 타입

    • PublicIpInstanceList 타입
    PublicIpInstanceList extends CommonResponse
    private Integer totalRows;
    private List publicIpInstanceList = new ArrayList();
    PublicIpInstance
    private String publicIpInstanceNo;
    private String publiclIp;
    private String publicIpDescription;
    private Date createDate;
    private String publicIpInstanceStatusName;
    private CommonCode publicIpInstanceStatus;
    private CommonCode publicIpInstanceOperation;
    private CommonCode publicIpKindType;
    private ServerInstance serverInstanceAssociatedWithPublicIp;
    private Region region;
    private Zone zone;

    예시

    호출

    ncloud server getPublicIpInstanceList --publicIpList 192.168.60.117 192.168.60.115
    

    응답

    {
      "getPublicIpInstanceListResponse": {
        "requestId": "dbf5e5bc-97c0-4164-9ee5-1128e50f5617",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 2,
        "publicIpInstanceList": [
          {
            "publicIpInstanceNo": "396562",
            "publicIp": "192.168.60.115",
            "publicIpDescription": "",
            "createDate": "2018-02-13T13:46:23+0900",
            "publicIpInstanceStatusName": "created",
            "publicIpInstanceStatus": {
              "code": "CREAT",
              "codeName": "NET CREAT State"
            },
            "publicIpInstanceOperation": {
              "code": "NULL",
              "codeName": "NET NULL OP"
            },
            "publicIpKindType": {
              "code": "GEN",
              "codeName": "General"
            },
            "serverInstanceAssociatedWithPublicIp": {},
            "zone": {
              "zoneNo": "2",
              "zoneName": "KR-1",
              "zoneCode": "KR-1",
              "zoneDescription": "KR-1 zone",
              "regionNo" : "1"
            }
          },
          {
            "publicIpInstanceNo": "397030",
            "publicIp": "192.168.60.117",
            "publicIpDescription": "test",
            "createDate": "2018-02-20T21:32:24+0900",
            "publicIpInstanceStatusName": "created",
            "publicIpInstanceStatus": {
              "code": "CREAT",
              "codeName": "NET CREAT State"
            },
            "publicIpInstanceOperation": {
              "code": "NULL",
              "codeName": "NET NULL OP"
            },
            "publicIpKindType": {
              "code": "GEN",
              "codeName": "General"
            },
            "serverInstanceAssociatedWithPublicIp": {},
            "zone": {
              "zoneNo": "2",
              "zoneName": "KR-1",
              "zoneCode": "KR-1",
              "zoneDescription": "KR-1 zone",
              "regionNo" : "1"
            }
          }
        ]
      }
    }
    
    <?xml version="1.0" encoding="UTF-8" ?>
    <getPublicIpInstanceListResponse>
      <requestId>dbf5e5bc-97c0-4164-9ee5-1128e50f5617</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>2</totalRows>
      <publicIpInstanceList>
        <publicIpInstanceNo>396562</publicIpInstanceNo>
        <publicIp>192.168.60.115</publicIp>
        <publicIpDescription></publicIpDescription>
        <createDate>2018-02-13T13:46:23+0900</createDate>
        <publicIpInstanceStatusName>created</publicIpInstanceStatusName>
        <publicIpInstanceStatus>
          <code>CREAT</code>
          <codeName>NET CREAT State</codeName>
        </publicIpInstanceStatus>
        <publicIpInstanceOperation>
          <code>NULL</code>
          <codeName>NET NULL OP</codeName>
        </publicIpInstanceOperation>
        <publicIpKindType>
          <code>GEN</code>
          <codeName>General</codeName>
        </publicIpKindType>
        <serverInstanceAssociatedWithPublicIp/>
        <zone>
          <zoneNo>2</zoneNo>
          <zoneName>KR-1</zoneName>
          <zoneCode>KR-1</zoneCode>
          <zoneDescription>KR-1 zone</zoneDescription>
          <regionNo>1</regionNo>
        </zone>
      </publicIpInstanceList>
      <publicIpInstanceList>
        <publicIpInstanceNo>397030</publicIpInstanceNo>
        <publicIp>192.168.60.117</publicIp>
        <publicIpDescription>test</publicIpDescription>
        <createDate>2018-02-20T21:32:24+0900</createDate>
        <publicIpInstanceStatusName>created</publicIpInstanceStatusName>
        <publicIpInstanceStatus>
          <code>CREAT</code>
          <codeName>NET CREAT State</codeName>
        </publicIpInstanceStatus>
        <publicIpInstanceOperation>
          <code>NULL</code>
          <codeName>NET NULL OP</codeName>
        </publicIpInstanceOperation>
        <publicIpKindType>
          <code>GEN</code>
          <codeName>General</codeName>
        </publicIpKindType>
        <serverInstanceAssociatedWithPublicIp/>
        <zone>
          <zoneNo>2</zoneNo>
          <zoneName>KR-1</zoneName>
          <zoneCode>KR-1</zoneCode>
          <zoneDescription>KR-1 zone</zoneDescription>
          <regionNo>1</regionNo>
        </zone>
      </publicIpInstanceList>
    </getPublicIpInstanceListResponse>
    

    이 문서가 도움이 되었습니까?

    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.