ListLoadBalancers
処理概要
ロードバランサーの情報一覧を取得します。 1回のリクエストで、複数のロードバランサー情報を取得できます。
リクエストURL
GET /v1/loadBalancers指定するパラメーター
なし
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| loadBalancers[] | object[] |
|
| ␣accountingType | integer |
当月の利用料金タイプ |
| ␣availabilityZones | string[] |
ゾーン情報 |
| ␣clusters[] | object[] |
|
| ␣␣name | string |
クラスター名 |
| ␣␣nodePools[] | object[] |
|
| ␣␣␣name | string |
ノードプール名 |
| ␣␣␣nodeCount | integer |
ノードプール内の現在のノード数 |
| ␣␣␣nodes[] | object[] |
|
| ␣␣␣␣availabilityZone | string |
ノードが存在しているゾーン名 |
| ␣␣␣␣healthCheckState | string |
ヘルスチェックの状態 値:
|
| ␣␣␣␣name | string |
ノード名 |
| ␣␣␣␣publicIpAddress | string |
グローバルIPアドレス |
| ␣createdTime | string |
作成日時 |
| ␣description | string |
メモ |
| ␣dnsName | string |
グローバルIPアドレス |
| ␣filter | object |
|
| ␣␣filterType | string |
指定したアクセス元IPアドレスへの対処 |
| ␣␣ipAddresses | string |
フィルター対象のアクセス元IPアドレスの情報セット |
| ␣healthCheck | object |
|
| ␣␣unhealthyThreshold | integer |
ヘルスチェック回数の閾値 |
| ␣␣interval | integer |
ヘルスチェック間隔 |
| ␣␣target | string |
PINGプロトコル:ポート(宛先) |
| ␣␣timeout | integer |
タイムアウト |
| ␣␣healthyThreshold | integer |
ヘルスチェックの復旧判断 |
| ␣listenerDescriptions[] | object[] |
|
| ␣␣listener | object |
|
| ␣␣␣protocol | string |
プロトコル |
| ␣␣␣loadBalancerPort | string |
待ち受けポート |
| ␣␣␣instancePort | string |
宛先ポート |
| ␣␣␣balancingType | string |
ロードバランス方式 |
| ␣␣␣sslCertificateId | string |
SSL証明書の発行識別子 |
| ␣loadBalancerName | string |
ロードバランサー名 |
| ␣networkVolume | string |
最大ネットワーク流量 |
| ␣nextMonthAccountingType | integer |
次月からの利用料金タイプ |
| ␣option | object |
|
| ␣␣sessionStickinessPolicy | object |
|
| ␣␣␣enabled | boolean |
オプション利用フラグ |
| ␣␣␣expirationPeriod | integer |
セッション保持時間 |
| ␣␣sorryPage | object |
|
| ␣␣␣enabled | boolean |
オプション利用フラグ |
| ␣␣␣statusCode | integer |
Sorry ページオプション情報 |
| ␣policyType | string |
暗号化タイプ |
リクエストサンプル
curl https://jp-east-1.hatoba.api.nifcloud.com/v1/loadBalancers
-H "X-Amz-Date: 20210511T124324Z"
-H "Authorization: AWS4-HMAC-SHA256 ..."
応答サンプル
{
"loadBalancers": [
{
"accountingType": 2,
"availabilityZones": [
"west-11"
],
"clusters": [
{
"name": "cluster01",
"nodePools": [
{
"name": "nodepool01",
"nodeCount": 2,
"nodes": [
{
"availabilityZone": "east-11",
"healthCheckState": "IN_SERVICE",
"name": "nodepool01-swiaj",
"publicIpAddress": "x.x.x.x"
},
{
"availabilityZone": "east-11",
"healthCheckState": "IN_SERVICE",
"name": "nodepool01-taqmb",
"publicIpAddress": "x.x.x.x"
}
]
}
]
}
],
"createdTime": "2021-05-11T21:40:15+09:00",
"description": "",
"dnsName": "x.x.x.x",
"filter": {
"filterType": 1,
"ipAddresses": [
{
"ipAddress": "*.*.*.*"
}
]
},
"healthCheck": {
"healthyThreshold": 1,
"interval": 30,
"target": "TCP:30550",
"timeout": 90,
"unhealthyThreshold": 1
},
"listenerDescriptions": [
{
"listener": {
"balancingType": 1,
"instancePort": 30550,
"loadBalancerPort": 80,
"protocol": "HTTP",
"sslCertificateId": 0
}
}
],
"loadBalancerName": "nginx",
"networkVolume": "10",
"nextMonthAccountingType": 2,
"option": {
"sessionStickinessPolicy": {
"enabled": false,
"expirationPeriod": 0
},
"sorryPage": {
"enabled": false,
"statusCode": 0
}
},
"policyType": "standard"
},
{
"accountingType": 2,
"availabilityZones": [
"east-11"
],
"clusters": [
{
"name": "cluster01",
"nodePools": [
{
"name": "nodepool01",
"nodeCount": 2,
"nodes": [
{
"availabilityZone": "east-11",
"healthCheckState": "IN_SERVICE",
"name": "nodepool01-swiaj",
"publicIpAddress": "x.x.x.x"
},
{
"availabilityZone": "east-11",
"healthCheckState": "IN_SERVICE",
"name": "nodepool01-taqmb",
"publicIpAddress": "x.x.x.x"
}
]
}
]
}
],
"createdTime": "2021-05-11T21:43:17+09:00",
"description": "",
"dnsName": "x.x.x.x",
"filter": {
"filterType": 1,
"ipAddresses": [
{
"ipAddress": "*.*.*.*"
}
]
},
"healthCheck": {
"healthyThreshold": 1,
"interval": 30,
"target": "TCP:30084",
"timeout": 90,
"unhealthyThreshold": 1
},
"listenerDescriptions": [
{
"listener": {
"balancingType": 1,
"instancePort": 30084,
"loadBalancerPort": 443,
"protocol": "HTTPS",
"sslCertificateId": 0
}
}
],
"loadBalancerName": "nginx",
"networkVolume": "10",
"nextMonthAccountingType": 2,
"option": {
"sessionStickinessPolicy": {
"enabled": false,
"expirationPeriod": 0
},
"sorryPage": {
"enabled": false,
"statusCode": 0
}
},
"policyType": "standard"
}
]
}
