Documentation Index

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

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

getLoadBalancedServerInstanceList

Prev Next

Available in Classic

View the list of server instances bound to a load balancer.

Request

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

Method URI
GET /loadbalancer/v2/getLoadBalancedServerInstanceList

Request headers

For information about the headers common to all Load Balancer APIs, see Load Balancer request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
loadBalancerInstanceNo String Required Number of the load balancer instance to which the list of server instances you want to view is bound

Request example

The following is a sample request.

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

Response

The following describes the response format.

Response body

See ServerInstance for the response body.

Response status codes

For information about the HTTP status codes common to all Load Balancer APIs, see Load Balancer response status codes.

Response example

The following is a sample response.

<getLoadBalancedServerInstanceListResponse>
    <requestId>891737c9-4319-4f52-b6ee-9907d26421eb</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <serverInstanceList>
        <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>Gasan 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>
    </serverInstanceList>
</getLoadBalancedServerInstanceListResponse>