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