ニフクラAPI (コンピューティング: DescribeLoadBalancers)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>コンピューティング> API> DescribeLoadBalancers

DescribeLoadBalancers

処理概要

指定したロードバランサーの情報を取得します。

ロードバランサーを指定するためには、ロードバランサー名が必要です。ロードバランサーを指定しない場合は、取得可能なすべてのロードバランサー情報を取得します。

ヘルスチェックの際のサーバー切り離し時間について

サーバーからの応答時間がタイムアウトを超えた場合にサーバーをロードバランサーから切り離します。
設定されるヘルスチェックのタイムアウト時間については、ロードバランサー（L4）のヘルスチェックについてをご確認ください。

指定するパラメーター

パラメーター	型	説明
LoadBalancerNames.member.n	string	ロードバランサー名 Default: 取得可能なすべてのロードバランサー
LoadBalancerNames.LoadBalancerPort.n	integer	待ち受けポート
LoadBalancerNames.InstancePort.n	integer	宛先ポート
Owner	string	ロードバランサー種別値: self (自身のロードバランサー) other (他者共有ロードバランサー) all (すべて) Default: self

応答フィールド

フィールド (項目)	型	説明
DescribeLoadBalancersResponse	-	DescribeLoadBalancers レスポンス
␣DescribeLoadBalancersResult	-	対象のロードバランサーの情報セット
␣␣LoadBalancerDescriptions	-	対象のロードバランサーの情報
␣␣␣member	-	対象のロードバランサーの情報
␣␣␣␣LoadBalancerName	string	ロードバランサー名
␣␣␣␣DNSName	string	グローバルIPアドレス
␣␣␣␣NetworkVolume	integer	最大ネットワーク流量単位: Mbps
␣␣␣␣PolicyType	string	暗号化タイプ値: standard (ATS非対応) ats (ATS対応)
␣␣␣␣ListenerDescriptions	-	ロードバランサーの設定情報セット
␣␣␣␣␣member	-	ロードバランサーの設定情報
␣␣␣␣␣␣Listener	-	ロードバランサーのポート設定情報
␣␣␣␣␣␣␣Protocol	string	プロトコル値: HTTP HTTPS FTP
␣␣␣␣␣␣␣LoadBalancerPort	integer	待ち受けポート
␣␣␣␣␣␣␣InstancePort	integer	宛先ポート
␣␣␣␣␣␣␣BalancingType	integer	ロードバランス方式備考: 返却値 1(Round-Robin),2(Least-Connection)
␣␣␣␣␣␣␣SSLCertificateId	string	SSL証明書の発行識別子
␣␣␣␣␣␣␣SSLPolicy	-	SSLセキュリティポリシー
␣␣␣␣␣␣␣␣SSLPolicyId	string	SSLセキュリティポリシーID
␣␣␣␣␣␣␣␣SSLPolicyName	string	SSLセキュリティポリシー名
␣␣␣␣Policies	-	※空を返却
␣␣␣␣␣AppCookieStickinessPolicies	-	※空を返却
␣␣␣␣␣␣member	-	※空を返却
␣␣␣␣␣␣␣PolicyName	string	※空を返却
␣␣␣␣␣␣␣CookieName	string	※空を返却
␣␣␣␣␣LBCookieStickinessPolicies	-	※空を返却
␣␣␣␣␣␣member	-	※空を返却
␣␣␣␣␣␣␣PolicyName	string	※空を返却
␣␣␣␣␣␣␣CookieExpirationPeriod	string	※空を返却
␣␣␣␣AvailabilityZones	-	ゾーン情報
␣␣␣␣␣member	string	ゾーン名
␣␣␣␣Instances	-	設定されているサーバー情報セット
␣␣␣␣␣member	-	設定されているサーバー情報
␣␣␣␣␣␣InstanceId	string	サーバー名
␣␣␣␣␣␣InstanceUniqueId	string	サーバーユニークID
␣␣␣␣HealthCheck	-	ヘルスチェック情報
␣␣␣␣␣Target	string	PINGプロトコル+":"+ポート(宛先)
␣␣␣␣␣Interval	integer	ヘルスチェック間隔単位: 秒
␣␣␣␣␣Timeout	integer	ヘルスチェックのタイムアウト時間 ※「処理概要」の「ヘルスチェックの際のサーバー切り離し時間について」を参照してください。単位: 秒
␣␣␣␣␣UnhealthyThreshold	integer	タイムアウトまでのヘルスチェック回数
␣␣␣␣␣HealthyThreshold	integer	ヘルスチェックの復旧判断 ※この回数を超えて連続してチェックに成功した場合、復旧したものと判断し、該当サーバーをロードバランサーに接続する備考: 返却値 1
␣␣␣␣␣InstanceStates	-	該当のサーバー情報セット
␣␣␣␣␣␣member	-	該当サーバーの情報
␣␣␣␣␣␣␣InstanceId	string	サーバー名
␣␣␣␣␣␣␣InstanceUniqueId	string	サーバーユニークID
␣␣␣␣␣␣␣State	string	ヘルスステータス値: InService (正常) OutOfService (応答なし)
␣␣␣␣␣␣␣ReasonCode	string	※空を返却
␣␣␣␣␣␣␣Description	string	※空を返却
␣␣␣␣Filter	Filter	フィルター情報
␣␣␣␣␣FilterType	string	指定したアクセス元IPアドレスへの対処備考: 返却値 1(許可する),2(拒否する)
␣␣␣␣␣IPAddresses	-	フィルター対象のアクセス元IPアドレスの情報セット
␣␣␣␣␣␣member	-	フィルター対象のアクセス元IPアドレス
␣␣␣␣␣␣␣IPAddress	string	アクセス元IPアドレス備考: 返却値 ...(すべてのIPアドレス) \| 特定のIPアドレス
␣␣␣␣CreatedTime	timestamp	作成日時表示形式:yyyy-mm-ddThh:mi:ss.sss+09:00
␣␣␣␣AccountingType	string	当月の利用料金タイプ値: 1 (月額課金) 2 (従量課金)
␣␣␣␣NextMonthAccountingType	string	次月からの利用料金タイプ値: 1 (月額課金) 2 (従量課金)
␣␣␣␣Option	-	ロードバランサーオプション情報
␣␣␣␣␣SessionStickinessPolicy	-	セッション固定オプション情報
␣␣␣␣␣␣Enabled	boolean	オプション利用フラグ値: true
␣␣␣␣␣␣ExpirationPeriod	integer	セッション保持時間単位: 分
␣␣␣␣␣SorryPage	-	Sorry ページオプション情報
␣␣␣␣␣␣Enabled	boolean	オプション利用フラグ値: true
␣␣␣␣␣␣StatusCode	integer	レスポンスコード備考: 返却値 200,503
␣␣␣␣Description	string	メモ
␣ResponseMetadata	-	リクエスト情報
␣␣RequestId	string	リクエスト識別子

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeLoadBalancers
  &LoadBalancerNames.member.1=lb0001
  &CommonParams

応答サンプル

    <DescribeLoadBalancersResponse xmlns="https://computing.api.nifcloud.com/api/">
  <DescribeLoadBalancersResult>
    <LoadBalancerDescriptions>
      <member>
        <LoadBalancerName>lb0001</LoadBalancerName>
        <DNSName>198.51.100.1</DNSName>
        <NetworkVolume>10</NetworkVolume>
        <PolicyType>standard</PolicyType>
        <ListenerDescriptions>
          <member>
            <Listener>
              <Protocol>HTTP</Protocol>
              <LoadBalancerPort>80</LoadBalancerPort>
              <InstancePort>80</InstancePort>
              <BalancingType>1</BalancingType>
              <SSLCertificateId>100</SSLCertificateId>
              <SSLPolicy>
                <SSLPolicyId>1</SSLPolicyId>
                <SSLPolicyName>Standard Ciphers A ver1</SSLPolicyName>
              </SSLPolicy>
            </Listener>
          </member>
        </ListenerDescriptions>
        <Policies>
          <AppCookieStickinessPolicies>
            <member>
              <PolicyName/>
              <CookieName/>
            </member>
          </AppCookieStickinessPolicies>
          <LBCookieStickinessPolicies>
            <member>
              <PolicyName/>
              <CookieExpirationPeriod/>
            </member>
          </LBCookieStickinessPolicies>
        </Policies>
        <AvailabilityZones>
          <member>east-11</member>
        </AvailabilityZones>
        <Instances>
          <member>
            <InstanceId>server02</InstanceId>
            <InstanceUniqueId>i-asdg1234</InstanceUniqueId>
          </member>
        </Instances>
        <HealthCheck>
          <Target>TCP:80</Target>
          <Interval>300</Interval>
          <Timeout>900</Timeout>
          <UnhealthyThreshold>3</UnhealthyThreshold>
          <HealthyThreshold>1</HealthyThreshold>
          <InstanceStates>
            <member>
              <InstanceId>Server001</InstanceId>
              <InstanceUniqueId>i-12345678</InstanceUniqueId>
              <State>InService</State>
              <ReasonCode/>
              <Description/>
            </member>
          </InstanceStates>
        </HealthCheck>
        <Filter>
          <FilterType>1</FilterType>
          <IPAddresses>
            <member>
              <IPAddress>203.0.113.100</IPAddress>
            </member>
            <member>
              <IPAddress>203.0.113.101</IPAddress>
            </member>
          </IPAddresses>
        </Filter>
        <CreatedTime>2010-05-17T11:22:33.456+09:00</CreatedTime>
        <AccountingType>1</AccountingType>
        <NextMonthAccountingType>1</NextMonthAccountingType>
        <Option>
          <SessionStickinessPolicy>
            <Enabled>true</Enabled>
            <ExpirationPeriod>10</ExpirationPeriod>
          </SessionStickinessPolicy>
          <SorryPage>
            <Enabled>true</Enabled>
            <StatusCode>200</StatusCode>
          </SorryPage>
        </Option>
        <Description>memo</Description>
      </member>
    </LoadBalancerDescriptions>
  </DescribeLoadBalancersResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</DescribeLoadBalancersResponse>