NiftyDescribeElasticLoadBalancers
処理概要
指定したマルチロードバランサーの情報を取得します。
マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。マルチロードバランサーを指定しない場合は、取得可能なすべてのマルチロードバランサー情報を取得します。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
ElasticLoadBalancers.ElasticLoadBalancerId.n | string |
対象のマルチロードバランサーユニークID |
|
ElasticLoadBalancers.ElasticLoadBalancerName.n | string |
対象のマルチロードバランサー名 使用可能文字: 半角英数字(15文字) |
|
ElasticLoadBalancers.Protocol.n | string |
プロトコル 値: TCP | UDP | HTTP | HTTPS |
|
ElasticLoadBalancers.ElasticLoadBalancerPort.n | integer |
待ち受けポート 使用可能文字: 1〜65535の数値 |
|
ElasticLoadBalancers.InstancePort.n | integer |
宛先ポート 使用可能文字: 1〜65535の数値 |
|
Filter.n.Name | string |
絞り込み条件の項目名 値: availability-zone (ゾーン) | state (マルチロードバランサーステータス) | elastic-loadbalancer-id (マルチロードバランサーユニークID) | elastic-loadbalancer-name (マルチロードバランサー名) | description (マルチロードバランサーメモ) | accounting-type (マルチロードバランサー利用料金タイプ) | ip-address (マルチロードバランサーのIP アドレス) | version (マルチロードバランサーのversion 情報) Default: なし |
|
Filter.n.Value.m | string |
絞り込み条件の値 Default: なし |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
NiftyDescribeElasticLoadBalancersResponse | - |
NiftyDescribeElasticLoadBalancersレスポンス Ancestor: なし Children: NiftyDescribeElasticLoadBalancersResult | ResponseMetadata |
NiftyDescribeElasticLoadBalancersResult | - |
マルチロードバランサーの情報セット Ancestor: NiftyDescribeElasticLoadBalancersResponse Children: ElasticLoadBalancerDescriptions |
ElasticLoadBalancerDescriptions | - |
マルチロードバランサーの情報 Ancestor: NiftyDescribeElasticLoadBalancersResult Children: member |
member | - |
マルチロードバランサーの情報 Ancestor: ElasticLoadBalancerDescriptions Children: ElasticLoadBalancerId | ElasticLoadBalancerName | DNSName | NetworkVolume | State | AccountingType | NextMonthAccountingType | ElasticLoadBalancerListenerDescriptions | AvailabilityZones | NetworkInterfaces | RouteTableId | RouteTableAssociationId | VersionInformation | CreatedTime |
ElasticLoadBalancerId | string |
マルチロードバランサーユニークID Ancestor: member Children: なし |
ElasticLoadBalancerName | string |
マルチロードバランサー名 Ancestor: member Children: なし |
DNSName | string |
VIPネットワーク IPアドレス Ancestor: member Children: なし |
NetworkVolume | string |
最大ネットワーク流量 値: 10 | 20 | 30 | 40 | 100 | 200 | 300 | 400 | 500 Ancestor: member Children: なし |
State | string |
マルチロードバランサーのステータス 値: pending (作成中・処理中・削除中) | available ( pending 以外 ) Ancestor: member Children: なし |
AccountingType | string |
当月の利用料金タイプ 値: 1(月額課金) | 2(従量課金) Ancestor: member Children: なし |
NextMonthAccountingType | string |
次月からの利用料金タイプ 値: 1(月額課金) | 2(従量課金) Ancestor: member Children: なし |
ElasticLoadBalancerListenerDescriptions | - |
マルチロードバランサーのポート設定情報 Ancestor: member Children: member |
member | - |
マルチロードバランサーのポート設定情報 Ancestor: ElasticLoadBalancerListenerDescriptions Children: Listener |
Listener | - |
マルチロードバランサーのポート設定情報 Ancestor: member Children: Protocol | ElasticLoadBalancerPort | InstancePort | BalancingType | Description | SSLCertificateId | SessionStickinessPolicy | SorryPage | Instances | HealthCheck |
Protocol | string |
プロトコル 値: TCP | UDP | HTTP | HTTPS Ancestor: Listener Children: なし |
ElasticLoadBalancerPort | integer |
待ち受けポート 値: 1~65535の数値 Ancestor: Listener Children: なし |
InstancePort | integer |
宛先ポート 値: 1~65535の数値 Ancestor: Listener Children: なし |
BalancingType | integer |
ロードバランス方式 値: 1 (Round-Robin) | 2 (Least-Connection) Ancestor: Listener Children: なし |
Description | string |
マルチロードバランサーのメモ情報(CDATA付) Ancestor: Listener Children: なし |
SSLCertificateId | string |
SSL証明書の発行識別子 Ancestor: Listener Children: なし |
SessionStickinessPolicy | - |
セッション固定情報 Ancestor: Listener Children: Enabled | Method | ExpirationPeriod |
Enabled | boolean |
セッション固定利用フラグ Ancestor: SessionStickinessPolicy Children: なし |
Method | integer |
セッション固定方法 値: 1 (ソースIPアドレス) | 2 (Cookie) Ancestor: SessionStickinessPolicy Children: なし |
ExpirationPeriod | integer |
セッション保持時間 単位: 分 値: 3~60 Ancestor: SessionStickinessPolicy Children: なし |
SorryPage | - |
Sorryページ情報 Ancestor: Listener Children: Enabled | RedirectUrl |
Enabled | boolean |
Sorryページ利用フラグ Ancestor: SessionStickinessPolicy Children: なし |
RedirectUrl | string |
Sorryページリダイレクト先URL(CDATA付) Ancestor: SessionStickinessPolicy Children: なし |
Instances | - |
設定されているサーバー情報セット Ancestor: Listener Children: member |
member | - |
設定されているサーバー情報 Ancestor: Instances Children: InstanceUniqueId | InstanceId |
InstanceUniqueId | string |
サーバーユニークID Ancestor: member Children: なし |
InstanceId | string |
サーバー名 Ancestor: member Children: なし |
HealthCheck | - |
ヘルスチェック情報 Ancestor: Listener Children: Target | Interval | UnhealthyThreshold | InstanceStates | Path | Expectation |
Target | string |
ヘルスチェック プロトコル Ancestor: HealthCheck Children: なし |
Interval | integer |
ヘルスチェック間隔(秒) Ancestor: HealthCheck Children: なし |
UnhealthyThreshold | integer |
ヘルスチェック回数閾値 Ancestor: HealthCheck Children: なし |
Path | string |
ヘルスチェックパス(CDATA付) Ancestor: HealthCheck Children: なし |
Expectation | - |
ヘルスチェック期待値セット Ancestor: HealthCheck Children: member |
member | - |
ヘルスチェック期待値情報 Ancestor: Expectation Children: HttpCode |
HttpCode | integer |
ヘルスチェック期待値 Ancestor: member Children: なし |
InstanceStates | - |
該当のサーバー情報セット Ancestor: HealthCheck Children: member |
member | - |
該当のサーバー情報 Ancestor: InstanceStates Children: InstanceUniqueId | InstanceId | State | ReasonCode | Description |
InstanceUniqueId | string |
サーバーユニークID Ancestor: member Children: なし |
InstanceId | string |
サーバー名 Ancestor: member Children: なし |
State | string |
ヘルスステータス Ancestor: member Children: なし |
ReasonCode | string |
※空を返却 Ancestor: member Children: なし |
Description | string |
※空を返却 Ancestor: member Children: なし |
AvailabilityZones | - |
ゾーン情報 Ancestor: member Children: member |
member | string |
ゾーン名 Ancestor: AvailabilityZones Children: なし |
NetworkInterfaces | - |
ネットワークインターフェース情報セット Ancestor: member Children: member |
member | - |
ネットワークインターフェース情報 Ancestor: NetworkInterfaces Children: NetworkId | NetworkName | DeviceIndex | IpAddress | IsVipNetwork | Description |
NetworkId | string |
ネットワークのユニークID Ancestor: member Children: なし |
NetworkName | string |
ネットワークの名前 Ancestor: member Children: なし |
DeviceIndex | integer |
デバイス番号 Ancestor: member Children: なし |
IpAddress | string |
IPアドレス Ancestor: member Children: なし |
IsVipNetwork | boolean |
VIPネットワークフラグ(待ち受けポートが設定されるネットワーク) Ancestor: member Children: なし |
Description | string |
ネットワークのメモ情報 Ancestor: member Children: なし |
RouteTableId | string |
ルートテーブルID Ancestor: member Children: なし |
RouteTableAssociationId | string |
ルートテーブル適用ID Ancestor: member Children: なし |
VersionInformation | - |
マルチロードバランサーのversion情報 Ancestor: member Children: IsLatest | Version |
IsLatest | boolean |
マルチロードバランサーのversion最新状態 値: true (最新) | false (最新以外) Ancestor: VersionInformation Children: なし |
Version | string |
マルチロードバランサーのversion情報 Ancestor: VersionInformation Children: なし |
CreatedTime | timestamp |
作成日時 Ancestor: member Children: なし |
ResponseMetadata | - |
リクエスト情報 Ancestor: NiftyDescribeElasticLoadBalancersResponse Children: RequestId |
RequestId | string |
リクエスト識別子 Ancestor: ResponseMetadata Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?
Action=NiftyDescribeElasticLoadBalancers
&ElasticLoadBalancers.ElasticLoadBalancerName.1=ELB1
&CommonParams
応答サンプル
<NiftyDescribeElasticLoadBalancersResponse xmlns="https://computing.api.nifcloud.com/api/">
<NiftyDescribeElasticLoadBalancersResult>
<ElasticLoadBalancerDescriptions>
<member>
<ElasticLoadBalancerId>elb-8db04f81</ElasticLoadBalancerId>
<ElasticLoadBalancerName>ELB1</ElasticLoadBalancerName>
<DNSName>192.0.2.0</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><![CDATA[Memo]]></Description>
<SSLCertificateId>100</SSLCertificateId>
<SessionStickinessPolicy>
<Enabled>true</Enabled>
<Method>1</Method>
<ExpirationPeriod>10</ExpirationPeriod>
</SessionStickinessPolicy>
<SorryPage>
<Enabled>true</Enabled>
<RedirectUrl><![CDATA[https://example.com/]]></RedirectUrl>
</SorryPage>
<Instances>
<member>
<InstanceUniqueId>i-0nzsfehj</InstanceUniqueId>
<InstanceId>server1</InstanceId>
</member>
</Instances>
<HealthCheck>
<InstanceStates>
<member>
<InstanceUniqueId>i-0nzsfehj</InstanceUniqueId>
<InstanceId>server1</InstanceId>
<State/>
<ReasonCode/>
<Description/>
</member>
</InstanceStates>
<Interval>10</Interval>
<Target>TCP:80</Target>
<UnhealthyThreshold>10</UnhealthyThreshold>
<Path><![CDATA[/healthcheck.html]]></Path>
<Expectation>
<member>
<HttpCode>200</HttpCode>
</member>
</Expectation>
</HealthCheck>
</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>
<RouteTableAssociationId>rtbassoc-22ax487d</RouteTableAssociationId>
<RouteTableId>rtb-13ad487a</RouteTableId>
<VersionInformation>
<IsLatest>true</IsLatest>
<Version>v1.0</Version>
</VersionInformation>
<CreatedTime>2016-08-24T15:10:00+09:00</CreatedTime>
</member>
</ElasticLoadBalancerDescriptions>
</NiftyDescribeElasticLoadBalancersResult>
<ResponseMetadata>
<RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
</ResponseMetadata>
</NiftyDescribeElasticLoadBalancersResponse>