DescribeLoadBalancers
処理概要
指定したロードバランサーの情報を取得します。
ロードバランサーを指定するためには、ロードバランサー名が必要です。ロードバランサーを指定しない場合は、取得可能なすべてのロードバランサー情報を取得します。削除済みのロードバランサーを指定した、管理外のロードバランサーを指定したなど、無効なロードバランサーを指定した場合は、エラーが返されます。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| LoadBalancerNames.member.n | ロードバランサー名 Type : String Default : 取得可能なすべてのロードバランサー |
lb0001 | |
| LoadBalancerNames.LoadBalancerPort.n | 待ち受けポート Type : Integer |
||
| LoadBalancerNames.InstancePort.n | 宛先ポート Type : Integer |
||
| Owner | ロードバランサー種別 Type : String 値 : self（自身のロードバランサー） | other（他者共有ロードバランサー） | all（すべて） Default : self |
応答フィールド
| フィールド(項目) | 説明 | サンプル値 |
|---|---|---|
| DescribeLoadBalancersResponse | DescribeLoadBalancers レスポンス Type : DescribeLoadBalancersResponse Ancestor : なし Children : DescribeLoadBalancersResult, ResponseMetadata |
|
| DescribeLoadBalancersResult | 対象のロードバランサーの情報セット Type : DescribeLoadBalancersResult Ancestor : DescribeLoadBalancersResponse Children : LoadBalancerDescriptions |
|
| LoadBalancerDescriptions | 対象のロードバランサーの情報 Type : LoadBalancerDescriptions Ancestor : DescribeLoadBalancersResult Children : member |
|
| member | 対象のロードバランサーの情報 Type : LoadBalancerDescription Ancestor : LoadBalancerDescriptions Children : LoadBalancerName, DNSName, NetworkVolume, PolicyType, ListenerDescriptions, Policies, AvailabilityZones, Instances, HealthCheck, Filter, CreatedTime, AccountingType, NextMonthAccountingType, Option, Description |
|
| LoadBalancerName | ロードバランサー名 Type : xsd:string Ancestor : member Children : なし |
lb0001 |
| DNSName | グローバルIPアドレス Type : xsd:string Ancestor : member Children : なし |
111.171.200.1 |
| NetworkVolume | 最大ネットワーク流量 Type : xsd:integer 単位 : Mbps Ancestor : member Children : なし |
10 |
| PolicyType | 暗号化タイプ Type : xsd:string 値: standard(ATS非対応) | ats(ATS対応) Ancestor : member Children : なし |
standard |
| ListenerDescriptions | ロードバランサーの設定情報セット Type : ListenerDescriptions Ancestor : member Children : member |
|
| member | ロードバランサーの設定情報 Type : ListenerDescription Ancestor : ListenerDescriptions Children : Listener |
|
| Listener | ロードバランサーのポート設定情報 Type : Listener Ancestor : member Children : Protocol, LoadBalancerPort, InstancePort, BalancingType, SSLCertificateId ,SSLPolicy |
|
| Protocol | プロトコル Type : xsd:string Ancestor : Listener Children : なし |
HTTP |
| LoadBalancerPort | 待ち受けポート Type : xsd:integer Ancestor : Listener Children : なし |
80 |
| InstancePort | 宛先ポート Type : xsd:integer Ancestor : Listener Children : なし |
80 |
| BalancingType | ロードバランス方式 Type : xsd:integer 値 : 1 (Round-Robin) | 2 (Least-Connection) Ancestor : Listener Children : なし |
1 |
| SSLCertificateId | SSL証明書の発行識別子 Type : xsd:string Ancestor : Listener Children : なし |
101 |
| SSLPolicy | SSLセキュリティポリシー Type : SSLPolicy Ancestor : Listener Children : SSLPolicyId, SSLPolicyName |
|
| SSLPolicyId | SSLセキュリティポリシーID Type :xsd:string Ancestor : SSLPolicy Children : なし |
|
| SSLPolicyName | SSLセキュリティポリシー名 Type :xsd:string Ancestor : SSLPolicy Children : なし |
|
| Policies | ※空を返却 Type : Policies Ancestor : member Children : AppCookieStickinessPolicies, LBCookieStickinessPolicies |
|
| AppCookieStickinessPolicies | ※空を返却 Type : AppCookieStickinessPolicies Ancestor : Policies Children : member |
|
| member | ※空を返却 Type : AppCookieStickinessPolicy Ancestor : AppCookieStickinessPolicies Children : PolicyName, CookieName |
|
| PolicyName | ※空を返却 Type : xsd:string Ancestor : member Children : なし |
|
| CookieName | ※空を返却 Type : xsd:string Ancestor : member Children : なし |
|
| LBCookieStickinessPolicies | ※空を返却 Type : LBCookieStickinessPolicies Ancestor : Policies Children : member |
|
| member | ※空を返却 Type : LBCookieStickinessPolicy Ancestor : LBCookieStickinessPolicies Children : PolicyName, CookieExpirationPeriod |
|
| PolicyName | ※空を返却 Type : xsd:string Ancestor : member Children : なし |
|
| CookieExpirationPeriod | ※空を返却 Type : xsd:string Ancestor : member Children : なし |
|
| AvailabilityZones | ゾーン情報 Type : AvailabilityZones Ancestor : member Children : member |
|
| member | ゾーン名 Type : xsd:string Ancestor : AvailabilityZones Children : なし |
east-11 |
| Instances | 設定されているサーバー情報セット Type : InstanceUniqueIds Ancestor : member Children : member |
|
| member | 設定されているサーバー情報 Type : InstanceUnique Ancestor : Instances Children : InstanceId, InstanceUniqueId |
|
| InstanceId | サーバー名 Type : xsd:string Ancestor : member Children : なし |
server02 |
| instanceUniqueId | サーバーユニークID Type : xsd:string Ancestor : member Children : なし |
i-asdg1234 |
| HealthCheck | ヘルスチェック情報 Type : HealthCheck Ancestor : member Children : Target, Interval, Timeout, UnhealthyThreshold, HealthyThreshold, InstanceStates |
|
| Target | PINGプロトコル+":"+ポート(宛先) Type : xsd:string Ancestor : HealthCheck Children : なし |
TCP:80 |
| Interval | ヘルスチェック間隔 Type : xs:integer 単位 : 秒 Ancestor : HealthCheck Children : なし |
300 |
| Timeout | タイムアウト Type : xs:integer 単位 : 秒 Ancestor : HealthCheck Children : なし |
900 |
| UnhealthyThreshold | ヘルスチェック回数の閾値
Ancestor : HealthCheck Children : なし |
3 |
| HealthyThreshold | ヘルスチェックの復旧判断
値 : 1 Ancestor : HealthCheck Children : なし |
1 |
| InstanceStates | 該当のサーバー情報セット Type: InstanceStates Ancestor: HealthCheck Children: member |
|
| member | 該当サーバーの情報 Type: InstanceState Ancestor: InstanceStates Children: InstanceId, InstanceUniqueId, State, ReasonCode, Description |
|
| InstanceId | サーバー名 Type: xsd:string Ancestor: member Children: なし |
|
| InstanceUniqueId | サーバーユニークID Type: xsd:string Ancestor: member Children: なし |
|
| State | ヘルスステータス Type: xsd:string 値：InService：OutOfService Ancestor: member Children: なし |
|
| ReasonCode | ※空を返却 Type: xsd:string Ancestor: member Children: なし |
|
| Description | ※空を返却 Type: xsd:string Ancestor: member Children: なし |
|
| Filter | フィルター情報 Type : Filter Ancestor : member Children : FilterType, IPAddresses |
|
| FilterType | 指定したアクセス元IPアドレスへの対処 Type : xsd:string 値 : 1(許可する) | 2(拒否する) Ancestor : Filter Children : なし |
1 |
| IPAddresses | フィルター対象のアクセス元IPアドレスの情報セット Type : FilterIPAddresses Ancestor : Filter Children : member |
|
| member | フィルター対象のアクセス元IPアドレス Type : FilterIPAddress Ancestor : IPAddresses Children : IPAddress |
|
| IPAddress | アクセス元IPアドレス Type : xsd:string 値 : *.*.*.*(すべてのIPアドレス) | 特定のIPアドレス(IPv4/IPv6) Ancestor : member Children : なし |
111.111.111.111 |
| CreatedTime | 作成日時(表示形式:yyyy-mm-ddThh:mi:ss.sssZ) Type : xs:dateTime Ancestor : member Children : なし |
2010-05-17T11:22:33.456Z |
| AccountingType | 当月の利用料金タイプ Type : xsd:string 値 : 1(月額課金) | 2(従量課金) Ancestor : member Children : なし |
|
| NextMonthAccountingType | 次月からの利用料金タイプ Type : xsd:string 値 : 1(月額課金) | 2(従量課金) Ancestor : member Children : なし |
|
| Option | ロードバランサーオプション情報 Type : LoadBalancerOption Ancestor : member Children : SessionStickinessPolicy, SorryPage, MobileFilter |
|
| SessionStickinessPolicy | セッション固定オプション情報 Type : SessionStickinessPolicyOption Ancestor : Option Children : Enabled, ExpirationPeriod |
|
| Enabled | オプション利用フラグ Type : xs:boolean 値 : true Ancestor : SessionStickinessPolicy Children : なし |
true |
| ExpirationPeriod | セッション保持時間 Type : xsd:int 単位 : 分 Ancestor : SessionStickinessPolicy Children : なし |
10 |
| SorryPage | Sorry ページオプション情報 Type : SorryPageOption Ancestor : Option Children : Enabled, StatusCode |
|
| Enabled | オプション利用フラグ Type : xs:boolean 値 : true Ancestor : SorryPage Children : なし |
true |
| StatusCode | レスポンスコード Type : xs:int 値 : 200 | 503 Ancestor : SorryPage Children : なし |
200 |
| MobileFilter | 携帯キャリアフィルターオプション情報 Ancestor : Option Type: MobileFilterOption Ancestor : Option Children : Enabled |
|
| Enabled | オプション利用フラグ Type: xs:boolean 値 : true Ancestor : MobileFilter Children : なし |
true |
| Description | メモ Type: xsd:string Ancestor: member Children: なし |
メモ |
| ResponseMetadata | リクエスト情報 Type : ResponseMetadata Ancestor : DescribeLoadBalancersResponse Children : RequestId |
|
| RequestId | リクエスト識別子 Type : xsd:string Ancestor : ResponseMetadata Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=DescribeLoadBalancers&LoadBalancerNames.member.1=lb0001&CommonParams
応答サンプル
<DescribeLoadBalancersResponse xmlns="https://cp.cloud.nifty.com/api/">
<DescribeLoadBalancersResult>
<LoadBalancerDescriptions>
<member>
<LoadBalancerName>lb0001</LoadBalancerName>
<DNSName>111.171.200.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>
</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>111.111.111.111</IPAddress>
<IPAddress>111.111.111.112</IPAddress>
</member>
</IPAddresses>
</Filter>
<CreatedTime>2010-05-17T11:22:33.456Z</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>
</member>
</LoadBalancerDescriptions>
</DescribeLoadBalancersResult>
<ResponseMetadata>
<RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
</ResponseMetadata>
</DescribeLoadBalancersResponse>
