本文へジャンプします。

ニフクラ APIリファレンス

NiftyDescribeElasticLoadBalancers

処理概要

指定したマルチロードバランサーの情報を取得します。
マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。マルチロードバランサーを指定しない場合は、取得可能なすべてのマルチロードバランサー情報を取得します。
削除済みのマルチロードバランサーを指定した、管理外のマルチロードバランサーを指定したなど、無効なマルチロードバランサーを指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
ElasticLoadBalancers.ElasticLoadBalancerId.n 対象のマルチロードバランサーユニークID
Type : String
  elb-8db04f81
ElasticLoadBalancers.ElasticLoadBalancerName.n 対象のマルチロードバランサー名
Type : String
使用可能文字 : 半角英数字(15文字)
   
ElasticLoadBalancers.Protocol.n プロトコル
Type : String
値 : TCP | UDP | HTTP | HTTP
   
ElasticLoadBalancers.ElasticLoadBalancerPort.n 待ち受けポート
Type : Integer
値 : 1〜65535の数値
   
ElasticLoadBalancers.InstancePort.n 宛先ポート
Type : Integer
値 : 1〜65535の数値
   
Filter.n.Name 絞り込み条件の項目名
Type : String
値 : availability-zone(ゾーン) | state(マルチロードバランサーステータス) | elastic-loadbalancer-id (マルチロードバランサーユニークID) |elastic-loadbalancer-name (マルチロードバランサー名) | description(マルチロードバランサーメモ) |accounting-type (マルチロードバランサー利用料金タイプ) |ip-address(マルチロードバランサーのIP アドレス) |version(マルチロードバランサーのversion 情報)
Default : なし
   
Filter.n.Value.m 絞り込み条件の値
Type : String
Default : なし
   

応答フィールド

フィールド 説明 サンプル値
NiftyDescribeElasticLoadBalancersResponse NiftyDescribeElasticLoadBalancersレスポンス
Type : NiftyDescribeElasticLoadBalancersResponse
Ancestor :なし
Children : NiftyDescribeElasticLoadBalancersResult, ResponseMetadata
 
NiftyDescribeElasticLoadBalancersResult マルチロードバランサーの情報セット
Type : NiftyDescribeElasticLoadBalancersResult
Ancestor : NiftyDescribeElasticLoadBalancersResponse
Children : ElasticLoadBalancerDescriptions
 
ElasticLoadBalancerId マルチロードバランサーユニークID
Type : xsd:string
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : なし
 
ElasticLoadBalancerName マルチロードバランサー名
Type : xsd:string
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : なし
 
DNSName VIPネットワーク IPアドレス
Type : xsd:string
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : なし
 
NetworkVolume 最大ネットワーク流量
Type : xsd:string
値 : 10 | 20 | 30 | 40 | 100 | 200 | 300 | 400 | 500
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : なし
 
State マルチロードバランサーのステータス
Type : xsd:string
値 : pending (作成中・処理中・削除中) | available(左記以外)
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children なし
 
AccountingType 当月の利用料金タイプ
Type : xsd:string
値 : 1(月額課金) | 2(従量課金)
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children なし
 
NextMonthAccountingType 次月からの利用料金タイプ
Type : xsd:string
値 : 1(月額課金) | 2(従量課金)
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : なし
 
ElasticLoadBalancerListenerDescriptions マルチロードバランサーのポート設定情報
Type : ElasticLoadBalancerListenerDescriptions
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : member
 
member マルチロードバランサーのポート設定情報
Type : member
Ancestor : ElasticLoadBalancerListenerDescriptions
Children : Listener
 
Listener マルチロードバランサーのポート設定情報
Type : Listener
Ancestor : member
Children : Protocol、ElasticLoadBalancerPort、InstancePort、BalancingType、Description、SSLCertificateId、SessionStickinessPolicy、SorryPage、Instances、HealthCheck
 
Protocol プロトコル
Type : xsd:string
値 : TCP | UDP | HTTP | HTTPS
Ancestor : Listener
Children : なし
 
ElasticLoadBalancerPort 待ち受けポート
Type : xsd:integer
値 : 1〜65535の数値
Ancestor : Listener
Children : なし
 
InstancePort 宛先ポート
Type : xsd:integer
値 : 1〜65535の数値
Ancestor : Listener
Children : なし
 
BalancingType ロードバランス方式
Type : xsd:string
値 : 1 (Round-Robin) | 2 (Least-Connection)
Ancestor : Listener
Children : なし
 
Description マルチロードバランサーのメモ情報
Type : xsd:string
Ancestor : Listener
Children : なし
 
SSLCertificateId SSL証明書の発行識別子
Type : xsd:string
Ancestor : Listener
Children : なし
 
SessionStickinessPolicy セッション固定情報
Type : SessionStickinessPolicy
Ancestor : Listener
Children : Enabled、Method、ExpirationPeriod
 
Enabled セッション固定利用フラグ
Type : xsd:boolean
Ancestor : SessionStickinessPolicy
Children : なし
 
Method セッション固定方法
Type : xsd:integer
値 : 1 (ソースIPアドレス) | 2 (Cookie)
Ancestor : SessionStickinessPolicy
Children : なし
 
ExpirationPeriod セッション保持時間
Type : xsd:integer
単位 : 分
値 : 3- 60
Ancestor : SessionStickinessPolicy
Children : なし
 
SorryPage Sorryページ情報
Type : SorryPage
Ancestor : Listener
Children : Enabled、RedirectUrl
 
Enabled Sorryページ利用フラグ
Type : xsd:boolean
Ancestor : SessionStickinessPolicy
Children : なし
 
RedirectUrl Sorryページリダイレクト先URL(CDATA付)
Type : xsd:string
Ancestor : SessionStickinessPolicy
Children : なし
 
Instances 設定されているサーバー情報セット
Type : InstanceUniqueIds
Ancestor : Listener
Children : member
 
member 設定されているサーバー情報
Type : InstanceUniqueId
Ancestor : InstanceUniqueIds
Children : InstanceUniqueId、 InstanceId
 
InstanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : member
Children : なし
 
InstanceId サーバー名
Type : xsd:string
Ancestor : member
Children : なし
 
HealthCheck ヘルスチェック情報
Type : HealthCheck
Ancestor : Listener
Children : Target、Interval、Timeout、UnhealthyThreshold、HealthyThreshold、Path、Expectation、InstanceStates
 
Target ヘルスチェック プロトコル
Type : xsd:string
Ancestor : HealthCheck
Children : なし
 
Interval ヘルスチェック間隔(秒)
Type : xsd:integer
Ancestor : HealthCheck
Children : なし
 
Timeout ※空を返却
Type : xsd:integer
Ancestor : HealthCheck
Children : なし
 
UnhealthyThreshold ヘルスチェック回数閾値
Type : xsd:integer
Ancestor : HealthCheck
Children : なし
 
HealthyThreshold ヘルスチェックの復旧判断
Type : xsd:integer
Ancestor : HealthCheck
Children : なし
 
Path ヘルスチェックパス
Type : xsd:string
Ancestor : HealthCheck
Children : なし
 
Expectation ヘルスチェック期待値セット
Type : Expectation
Ancestor : HealthCheck
Children : member
 
member ヘルスチェック期待値情報
Type : member
Ancestor : Expectation
Children : HttpCode
 
HttpCode ヘルスチェック期待値
Type : xsd:integer
Ancestor : member
Children : なし
 
InstanceStates 該当のサーバー情報セット
Type : InstanceStates
Ancestor : HealthCheck
Children : member
 
member 該当のサーバー情報
Type : InstanceState
Ancestor : InstanceStates
Children : InstanceUniqueId、InstanceId
 
InstanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : member
Children : なし
 
InstanceId サーバー名
Type : xsd:string
Ancestor : member
Children : なし
 
AvailabilityZones ゾーン情報
Type : AvailabilityZones
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : member
 
member ゾーン名
Type : xsd:string
Ancestor : AvailabilityZones
Children : なし
 
NetworkInterfaces ネットワークインターフェース情報セット
Type : NetworkInterfaces
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : member
 
member ネットワークインターフェース情報
Type : NetworkInterface
Ancestor : member
Children : NetworkId、NetworkName、DeviceIndex、IpAddress、IsVipNetwork、Description
 
NetworkId ネットワークのユニークID
Type : xsd:string
Ancestor : member
Children : なし
 
NetworkName ネットワークの名前
Type : xsd:string
Ancestor : member
Children : なし
 
DeviceIndex デバイス番号
Type : xsd:integer
Ancestor : member
Children : なし
 
IpAddress IPアドレス
Type : xsd:string
Ancestor : member
Children : なし
 
IsVipNetwork VIPネットワークフラグ(待ち受けポートが設定されるネットワーク)
Type : xsd:boolean
Ancestor : member
Children : なし
 
Description ネットワークのメモ情報
Type : xsd:string
Ancestor : member
Children : なし
 
VersionInformation マルチロードバランサーのversion情報
Type : versionInformationType
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : IsLatest、Version
 
IsLatest マルチロードバランサーのversion最新状態
Type : xsd:boolean
値 : true (最新) | false (最新以外)
Ancestor : VersionInformation
Children : なし
 
Version マルチロードバランサーのversion情報
Type : xsd:boolean
Ancestor : VersionInformation
Children : なし
 
CreatedTime 作成日時
Type : xsd:dateTime
Ancestor : NiftyDescribeElasticLoadBalancersResult
Children : なし
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : NiftyDescribeElasticLoadBalancersResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor :ResponseMetadata
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyDescribeElasticLoadBalancers&ElasticLoadBalancers.ElasticLoadBalancerName.1=ELB1

応答サンプル

<NiftyDescribeElasticLoadBalancersResponse xmlns="https://cp.cloud.nifty.com/api/">
  <NiftyDescribeElasticLoadBalancersResult>
    <ElasticLoadBalancerDescriptions>
      <member>
        <ElasticLoadBalancerId>elb-8db04f81</ElasticLoadBalancerId>
        <ElasticLoadBalancerName>ELB1</ElasticLoadBalancerName>
        <DNSName>124.25.72.33</DNSName>
        <NetworkVolume>20</NetworkVolume>
        <State>available</State>
        <AccountingType>1</AccountingType>
        <NextMonthAccountingType>2</NextMonthAccountingType>
        <ElasticLoadBalancerListenerDescriptions>
          <member>
            <Listener>
              <Protocol>TCP</Protocol>
              <ElasticLoadBalancerPort>80</ElasticLoadBalancerPort>
              <InstancePort>80</InstancePort>
              <BalancingType>1</BalancingType>
              <Description/>
              <SSLCertificateId/>
              <SessionStickinessPolicy>
                <Enabled>true</Enabled>
                <Method>1</Method>
                <ExpirationPeriod>10</ExpirationPeriod>
              </SessionStickinessPolicy>
              <SorryPage>
                <Enabled>false</Enabled>
              </SorryPage>
              <Instances/>
              <HealthCheck>
                <Target>TCP:80</Target>
                <Interval>10</Interval>
                <Timeout/>
                <UnhealthyThreshold>10</UnhealthyThreshold>
                <HealthyThreshold>10</HealthyThreshold>
                <Path><![CDATA[/healthcheck.html]]></Path>
                <Expectation>
                  <member>
                    <HttpCode>200</HttpCode>
                  </member>
                  <member>
                    <HttpCode>302</HttpCode>
                  </member>
                </Expectation>
              </HealthCheck>
              <InstanceStates/>
            </Listener>
          </member>
        </ElasticLoadBalancerListenerDescriptions>
        <AvailabilityZones>
          <member>east-11</member>
        </AvailabilityZones>
        <NetworkInterfaces>
          <member>
            <NetworkId>net-COMMON_GLOBAL</NetworkId>
            <NetworkName/>
            <DeviceIndex>1</DeviceIndex>
            <IpAddress>192.168.0.100</IpAddress>
            <IsVipNetwork>true</IsVipNetwork>
            <Description/>
          </member>
        </NetworkInterfaces>
        <VersionInformation>
          <IsLatest>true</IsLatest>
          <Version>edge-1.0</Version>
        </VersionInformation>
        <CreatedTime>2016-08-24T15:10:00+09:00</CreatedTime>
      </member>
    </LoadBalancerDescriptions>
  </NiftyDescribeElasticLoadBalancersResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyDescribeElasticLoadBalancersResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上