Show All Listeners#
リスナーを一覧表示します。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://nfv.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://nfv.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/lb/nfv/listeners/
HTTPステータスコード#
正常時:200
レスポンスボディ(正常系)の説明#
| 名前 | Type | Description |
|---|---|---|
| listeners | array | リスナーオブジェクトのリスト |
| name | string | リスナーの名前 |
| loadbalancer_name | string | リスナーが設定されているロードバランサ名 |
| id | string | リスナーのID |
| type | string | リスナーのタイプ |
| protocol | string | リスナーの待ち受けプロトコル |
| port | string | リスナーの待ち受けポート |
| distribution_mode | string | リスナーが利用する振り分けアルゴリズム |
| persistence_mode | string | リスナーで利用する一意性保証方法 |
| fqdn | string | リスナーに設定されたFQDN名 |
| members | array | メンバーのリスト |
| instance_id | string | 振り分け先のサーバ情報 |
| port_mapping | string | 振り分け先のサーバ待ち受けポート |
| server_name | string | 振り分け先のサーバ名 |
| healthcheck | object | ヘルスチェックのオブジェクト |
| interval | string | ヘルスチェックの実施時間間隔(秒単位) |
| timeout | string | ヘルスチェック応答のタイムアウト時間(ミリ秒単位) |
| unhealthythreshold | string | 対象の分散先サーバを障害と判断し振り分け先から除外するためのヘルスチェック連続失敗回数 |
| target | string | ヘルスチェックの実施方法 |
| url_path | string | ヘルスチェックで確認するURLパス |
| ssl_id | string | SSL証明書のID |
| status | string | 設定ステータス ACTIVE / BUILD / DELETING / CREATE_ERROR / UPDATE_ERROR / DELETE_ERROR |
| tenant_id | string | リスナーが属するプロジェクト |
| detail | string | 詳細情報 |
| access_IPaddress | string | リスナーのIPアドレス |
レスポンス例#
{ "listeners": [ { "name": "listener01", "loadbalancer_name": "LB01", "id": "1113", "type": "internal", "protocol": "tcp", "port": "8080", "distribution_mode": "round-robin", "persistence_mode": "connection", "members": [ { "instance_id": "192.168.20.8", "port_mapping": "90", "server_name": "webserver01" } ], "healthcheck": { "interval": "30", "timeout": "5000", "unhealthythreshold": "3", "target": "http", "url_path": "/index.html" }, "ssl_id": "4ff61c0c-1064-4e61-970a-db3886126ae5", "status": "ACTIVE", "tenant_id": "b85ec51046664edf81322aa61379bf43", "detail":"", "access_IPaddress":"192.168.90.136", "fqdn": "lb-testuser7-b3342e70-0046-25d9-625c-782fb5d72a5e.elb.tps5.fujitsu.com" } ] }