Documentation Index

Fetch the complete documentation index at: https://api-gov.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getLoadBalancerInstanceList

Prev Next

Classic 환경에서 이용 가능합니다.

사용자가 지정한 조건에 따라 로드 밸런서 인스턴스의 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /loadbalancer/v2/getLoadBalancerInstanceList

요청 헤더

Load Balancer API에서 공통으로 사용하는 헤더에 대한 정보는 Load Balancer 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
loadBalancerInstanceNoList.N String Optional 로드 밸런서 인스턴스의 번호 목록
  • <예시> loadBalancerInstanceNoList.1=123&loadBalancerInstanceNoList.2=345
networkUsageTypeCode String Optional 로드 밸런서의 네크워크 유형
  • PBLIP | PRVT
    • PBLIP (Public): 공인 IP
    • PRVT (Private): 사설 IP
regionNo String Optional 리전 번호
zoneNo String Optional 존 번호
  • getZoneList 참조
  • 리전 번호와 존 번호 모두 입력 시 존 번호를 기준으로 조회
  • pageNo Integer Optional 페이징 처리된 결과의 페이지 번호
    • 0~2147483647
    pageSize Integer Optional 한 페이지에 보여줄 결과 개수
    • 0~2147483647
    sortedBy String Optional 정렬 기준
    • loadBalancerInstanceNo (기본값) | loadBalancerName
      • loadBalancerInstanceNo: 로드 밸런서의 번호
      • loadBalancerName: 로드 밸런서의 이름
    sortList.N.sortingOrder String Optional 정렬 순서
    • ascending (기본값) | descending
      • ascending: 오름차순
      • descending: 내림차순

    요청 예시

    요청 예시는 다음과 같습니다.

    curl --location 'https://ncloud.apigw.gov-ntruss.com/loadbalancer/v2/getLoadBalancerInstanceList?loadBalancerInstanceNoList.1=******' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

    응답 바디는 LoadBalancerInstance를 참조해 주십시오.

    응답 상태 코드

    네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    <getLoadBalancerInstanceListResponse>
        <requestId>352b6436-780d-4e6c-9ade-3828f213ba33</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <loadBalancerInstanceList>
            <loadBalancerInstance>
                <loadBalancerInstanceNo>********</loadBalancerInstanceNo>
                <virtualIp>***.**.***.***,**.**.***.***</virtualIp>
                <loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
                <loadBalancerAlgorithmType>
                    <code>RR</code>
                    <codeName>Round Robin</codeName>
                </loadBalancerAlgorithmType>
                <loadBalancerDescription></loadBalancerDescription>
                <createDate>2024-06-07T18:30:37+0900</createDate>
                <domainName>***.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>
                <region>
                    <regionNo>1</regionNo>
                    <regionCode>KR</regionCode>
                    <regionName>Korea</regionName>
                </region>
                <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>
                <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>
                    <loadBalancedServerInstance>
                        <serverInstance>
                            <serverInstanceNo>********</serverInstanceNo>
                            <serverName>YOUR_SERVER</serverName>
                            <serverDescription></serverDescription>
                            <cpuCount>2</cpuCount>
                            <memorySize>4294967296</memorySize>
                            <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                            <platformType>
                                <code>UBS64</code>
                                <codeName>Ubuntu Server 64 Bit</codeName>
                            </platformType>
                            <loginKeyName>YOUR_LOGIN_KEY</loginKeyName>
                            <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                            <publicIp></publicIp>
                            <privateIp>**.**.***.***</privateIp>
                            <serverImageName>ubuntu-18.04</serverImageName>
                            <serverInstanceStatus>
                                <code>RUN</code>
                                <codeName>Server run state</codeName>
                            </serverInstanceStatus>
                            <serverInstanceOperation>
                                <code>NULL</code>
                                <codeName>Server NULL OP</codeName>
                            </serverInstanceOperation>
                            <serverInstanceStatusName>running</serverInstanceStatusName>
                            <createDate>2024-06-07T18:28:41+0900</createDate>
                            <uptime>2024-06-07T18:35:09+0900</uptime>
                            <serverImageProductCode>SPSW0LINUX000130</serverImageProductCode>
                            <serverProductCode>SPSVRSSD00000003</serverProductCode>
                            <isProtectServerTermination>false</isProtectServerTermination>
                            <portForwardingPublicIp>***.***.***.***</portForwardingPublicIp>
                            <zone>
                                <zoneNo>2</zoneNo>
                                <zoneName>KR-1</zoneName>
                                <zoneCode>KR-1</zoneCode>
                                <zoneDescription>가산 zone</zoneDescription>
                                <regionNo>1</regionNo>
                            </zone>
                            <region>
                                <regionNo>1</regionNo>
                                <regionCode>KR</regionCode>
                                <regionName>Korea</regionName>
                            </region>
                            <baseBlockStorageDiskType>
                                <code>NET</code>
                                <codeName>Network Storage</codeName>
                            </baseBlockStorageDiskType>
                            <baseBlockStorageDiskDetailType>
                                <code>SSD</code>
                                <codeName>SSD</codeName>
                            </baseBlockStorageDiskDetailType>
                            <serverInstanceType>
                                <code>STAND</code>
                                <codeName>Standard</codeName>
                            </serverInstanceType>
                            <userData></userData>
                            <initScriptNo></initScriptNo>
                            <accessControlGroupList>
                                <accessControlGroup>
                                    <accessControlGroupConfigurationNo>******</accessControlGroupConfigurationNo>
                                    <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                                    <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                                    <isDefault>true</isDefault>
                                    <createDate>2021-06-22T18:09:57+0900</createDate>
                                </accessControlGroup>
                            </accessControlGroupList>
                            <instanceTagList/>
                        </serverInstance>
                        <serverHealthCheckStatusList>
                            <serverHealthCheckStatus>
                                <protocolType>
                                    <code>HTTP</code>
                                    <codeName>http</codeName>
                                </protocolType>
                                <loadBalancerPort>80</loadBalancerPort>
                                <serverPort>80</serverPort>
                                <l7HealthCheckPath>/</l7HealthCheckPath>
                                <proxyProtocolUseYn>N</proxyProtocolUseYn>
                                <serverStatus>false</serverStatus>
                            </serverHealthCheckStatus>
                        </serverHealthCheckStatusList>
                    </loadBalancedServerInstance>
                </loadBalancedServerInstanceList>
            </loadBalancerInstance>
        </loadBalancerInstanceList>
    </getLoadBalancerInstanceListResponse>