getLoadBalancerInstanceList
    • PDF

    getLoadBalancerInstanceList

    • PDF

    記事の要約

    Classic環境で利用できます。

    ユーザーが指定した条件に基づいてロードバランサインスタンスのリストを照会します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/getLoadBalancerInstanceList

    リクエストヘッダ

    Load Balancer APIで共通して使用されるヘッダの詳細は、Load Balancerの共通ヘッダをご参照ください。

    リクエストクエリパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    loadBalancerInstanceNoList.NStringOptionalロードバランサインスタンスの番号リスト
    • <例> loadBalancerInstanceNoList.1=123&loadBalancerInstanceNoList.2=345
    networkUsageTypeCodeStringOptionalロードバランサのネットワークタイプ
    • PBLIP | PRVT
      • PBLIP (Public): グローバル IPアドレス
      • PRVT (Private): プライベート IPアドレス
    regionNoStringOptionalリージョン番号
    • 1(デフォルト)
      • 1 (KR): 韓国リージョン
    • getRegionListを通じて確認
    zoneNoStringOptionalゾーン番号
  • getZoneListを通じて確認
  • リージョン番号とゾーン番号を両方入力する場合、ゾーン番号で照会
  • pageNoIntegerOptionalページング処理された結果のページ番号
    • 0~2147483647
    pageSizeIntegerOptionalページごとに表示する結果数
    • 0~2147483647
    sortedByStringOptionalソート基準
    • loadBalancerInstanceNo(デフォルト) | loadBalancerName
      • loadBalancerInstanceNo: ロードバランサの番号
      • loadBalancerName: ロードバランサの名前
    sortList.N.sortingOrderStringOptionalソート順序
    • ascending(デフォルト) | descending
      • ascending: 昇順
      • descending: 降順

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location 'https://ncloud.apigw.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をご参照ください。

    レスポンスステータスコード

    NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、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>
    

    この記事は役に立ちましたか?

    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.