getLoadBalancerInstanceList
    • PDF

    getLoadBalancerInstanceList

    • PDF

    기사 요약

    개요

    로드밸런서 인스턴스들을 조회합니다.

    요청

    요청 헤더

    헤더 명설명
    x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄
    API Gateway 서버와 시간차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-apigw-api-keyAPI Gateway에서 발급받은 키(v2버전에서는 필요 없음)
    x-ncp-iam-access-key네이버 클라우드 플랫폼[공공기관용]에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey
    x-ncp-apigw-signature-v2Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명
    HMAC 암호화 알고리즘은 HmacSHA256 사용

    요청 파라미터

    파라미터 명필수 여부타입제약사항설명
    loadBalancerInstanceNoList.NNoString중복 불가- 로드밸런서인스턴스 번호리스트
    로드밸런서번호를 리스트로 받아 조회 시 필터링 가능
    <예시> loadBalancerInstanceNoList.1=123&loadBalancerInstanceNoList.2=345
    networkUsageTypeCodeNoStringMin: 1
    Max: 5
    네트워크 용도 구분 코드를 받아 조회 시 필터링 가능(공인 IP 로드밸런서/사설IP 로드밸런서)
    PBLIP(Public) PRVT(Private)
    regionNoNoString리전 번호를 받아 조회 시 해당하는 리전으로만 필터링 가능
    리전 번호는 getRegionList 액션을 통해서 획득 가능
    - default : 1 (KR)
    zoneNoNoString존 번호를 받아 조회 시 해당하는 존으로만 필터링 가능
    존 번호는 getZoneList 액션을 통해 획득 가능
    리전 번호와 존 번호를 모두 입력할 경우 존 번호를 기준으로 조회
    pageNoNoIntegerMin: 0
    Max: 2147483647
    - 페이징 된 결과의 페이지 번호
    결괏값은 pageNo pageSize를 이용하여 페이징 처리 가능
    pageSizeNoInteger- Min: 0
    - Max: 2147483647
    - 페이징 시 보여줄 각 페이지 사이즈
    결괏값은 pageNo pageSize를 이용하여 페이징 처리 가능
    sortedByNoString리스트 결과에 대한 정렬 대상 설정 가능
    loadBalancerName(로드밸런서명)
    loadBalancerInstanceNo(로드밸런서인스턴스 번호)
    default :loadBalancerInstanceNo(로드밸런서인스턴스 번호)
    대소문자 구분 없음
    sortingOrderNoString오름차순, 내림차순에 대한 목록 결과에 ordering 결정
    ascending(오름차순)
    descending(내림차순)
    default: ascending(오름차순)
    대소문자 구분 없음

    응답

    응답 바디

    예시

    요청 예시

    GET {LOADBALANCER_API_URL}/loadbalancer/v2/getLoadBalancerInstanceList?loadBalancerInstanceNoList.1=757593
    

    응답 예시

    아래 에러 코드는 이 액션(Action)에서 특징적으로 발생하는 에러입니다. 공통적으로 발생하는 에러에 대한 상세한 설명은 NAVER Cloud Platform API를 참고해 주십시오.

    <getLoadBalancerInstanceListResponse>
      <requestId>9a1fd360-8f49-4842-b0fa-2f06d28234b4</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <loadBalancerInstanceList>
        <loadBalancerInstance>
          <loadBalancerInstanceNo>1083108</loadBalancerInstanceNo>
          <virtualIp>49.236.150.32,49.236.151.188</virtualIp>
          <loadBalancerName>penguin</loadBalancerName>
          <zoneList>
            <zone>
              <zoneNo>2</zoneNo>
              <zoneName>KR-1</zoneName>
              <zoneCode>KR-1</zoneCode>
              <zoneDescription>가산 zone</zoneDescription>
              <regionNo>1</regionNo>
            </zone>
            <zone>
              <zoneNo>3</zoneNo>
              <zoneName>KR-2</zoneName>
              <zoneCode>KR-2</zoneCode>
              <zoneDescription>평촌 zone</zoneDescription>
              <regionNo>1</regionNo>
            </zone>
          </zoneList>
          <region>
            <regionNo>1</regionNo>
            <regionCode>KR</regionCode>
            <regionName>Korea</regionName>
          </region>
          <loadBalancerAlgorithmType>
            <code>RR</code>
            <codeName>Round Robin</codeName>
          </loadBalancerAlgorithmType>
          <loadBalancerDescription></loadBalancerDescription>
          <createDate>2018-11-26T11:04:31+0900</createDate>
          <domainName>slb-1083108.ncloudslb.com</domainName>
          <loadBalancerInstanceStatusName>used</loadBalancerInstanceStatusName>
          <loadBalancerInstanceStatus>
            <code>USED</code>
            <codeName>NET USED state</codeName>
          </loadBalancerInstanceStatus>
          <loadBalancerInstanceOperation>
            <code>NULL</code>
            <codeName>NET NULL OP</codeName>
          </loadBalancerInstanceOperation>
          <networkUsageType>
            <code>PBLIP</code>
            <codeName>Public</codeName>
          </networkUsageType>
          <isHttpKeepAlive>false</isHttpKeepAlive>
          <connectionTimeout>60</connectionTimeout>
          <certificateName></certificateName>
          <loadBalancerRuleList>
            <loadBalancerRule>
              <protocolType>
                <code>HTTP</code>
                <codeName>http</codeName>
              </protocolType>
              <loadBalancerPort>80</loadBalancerPort>
              <serverPort>80</serverPort>
              <l7HealthCheckPath>/</l7HealthCheckPath>
              <certificateName></certificateName>
              <proxyProtocolUseYn>N</proxyProtocolUseYn>
              <stickySessionUseYn>N</stickySessionUseYn>
              <http2UseYn>N</http2UseYn>
            </loadBalancerRule>
          </loadBalancerRuleList>
          <loadBalancedServerInstanceList/>
        </loadBalancerInstance>
      </loadBalancerInstanceList>
    </getLoadBalancerInstanceListResponse>
    

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

    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.