GetLoadBalancer
処理概要
ロードバランサーの情報を取得します。
リクエストURL
GET /v1/loadBalancers/{LoadBalancerName}?loadBalancerPort=n&instancePort=n
指定するパラメーター
パスパラメーター
パラメーター |
型 |
説明 |
必須 |
LoadBalancerName |
string |
情報を取得したいクラスター名
|
○
|
クエリパラメーター
パラメーター |
型 |
説明 |
必須 |
loadBalancerPort |
integer |
待ち受けポート
|
○
|
instancePort |
integer |
宛先ポート
|
○
|
応答フィールド
フィールド (項目) |
型 |
説明 |
loadBalancers |
object |
|
␣accountingType |
integer |
当月の利用料金タイプ
|
␣availabilityZones |
string[] |
ゾーン情報
|
␣clusters[] |
object[] |
|
␣␣name |
string |
クラスター名
|
␣␣nodePools[] |
object[] |
|
␣␣␣name |
string |
ノードプール名
|
␣␣␣nodeCount |
integer |
ノードプール内の現在のノード数
|
␣␣␣nodes[] |
object[] |
|
␣␣␣␣availabilityZone |
string |
ノードが存在しているゾーン名
|
␣␣␣␣healthCheckState |
string |
ヘルスチェックの状態
値: IN_SERVICE (稼動中) | OUT_OF_SERVICE (非稼動中)
|
␣␣␣␣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 |
|
␣␣␣statusCode |
integer |
Sorry ページオプション情報
|
␣policyType |
string |
暗号化タイプ
|
リクエストサンプル
curl https://jp-east-1.hatoba.api.nifcloud.com/v1/loadBalancers/nginx?load_balancer_port=80&instance_port=32756
-H "X-Amz-Date: 20210601T053651Z"
-H "Authorization: AWS4-HMAC-SHA256 ..."
応答サンプル
{
"loadBalancer": {
"accountingType": 2,
"availabilityZones": [
"east-11"
],
"clusters": [
{
"name": "cluster01",
"nodePools": [
{
"name": "nodepool01",
"nodeCount": 1,
"nodes": [
{
"availabilityZone": "east-11",
"healthCheckState": "IN_SERVICE",
"name": "nodepool01-6ydqy",
"publicIpAddress": "x.x.x.x"
}
]
}
]
}
],
"createdTime": "2021-06-01T14:13:06+09:00",
"description": "",
"dnsName": "x.x.x.x",
"filter": {
"filterType": 1,
"ipAddresses": [
{
"ipAddress": "*.*.*.*"
}
]
},
"healthCheck": {
"healthyThreshold": 1,
"interval": 60,
"target": "ICMP",
"timeout": 240,
"unhealthyThreshold": 1
},
"listenerDescriptions": [
{
"listener": {
"balancingType": 1,
"instancePort": 32756,
"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"
}
}