List Listeners#

プロジェクトのリスナーを一覧表示します。

APIエンドポイント#

リージョン	APIエンドポイント
西日本リージョン3の場合	https://loadbalancer.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合	https://loadbalancer.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v2.0/lbaas/listeners

HTTPステータスコード#

正常時：200

エラー時：400, 401, 500

リクエストパラメータの説明#

名前	In	Type	デフォルト値 /必須指定	Description
fields	query	string	任意	属性を指定します。省略した場合は、すべての属性が表示されます。複数指定ができます。例えば、fields=id&fields=nameと指定すると、「id」と「name」の属性だけが表示されます。

レスポンスボディ（正常系）の説明#

名前	Type	Description
admin_state_up	boolean	リソースの管理状態「true」または「false」が表示されます。
allowed_cidrs	array	アクセスを許可するIPアドレス範囲
connection_limit	integer	リスナーに許可されているコネクションの上限値デフォルトは-1です(1000000コネクションになります)。
created_at	string	リソースが作成された日時(UTC)のタイムスタンプ
default_pool_id	uuid	マッチするL7ポリシーがない場合に、リスナーが利用するプールのID
default_tls_container_ref	string	参照するTLSシークレットコンテナのURL
description	string	リソースの説明
id	uuid	リスナーID
insert_headers	object	バックエンドのメンバーに送信する際挿入されるオプションヘッダのオブジェクト「X-Forwarded-For」、「X-Forwarded-Port」が含まれます。
l7policies	array	L7ポリシーIDの一覧
listeners	array	リスナーオブジェクトの一覧
loadbalancers	array	ロードバランサーIDの一覧
name	string	リソース名
operating_status	string	リソースの運用状況「ONLINE」、「OFFLINE」または「ERROR」が表示されます。 operating_statusの詳細は「Operating Status Codes」を参照してください。
project_id	string	プロジェクトID
protocol	string	プロトコル「HTTP」、「HTTPS」、「TCP」または「TERMINATED_HTTPS」が表示されます。
protocol_port	integer	リスニングするTCPのポート番号
provisioning_status	string	リソースの提供状況「ACTIVE」、「PENDING_CREATE」、「PENDING_UPDATE」または「ERROR」が表示されます。 provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。
sni_container_refs	array	参照するTLSシークレットコンテナのURLの一覧
tags	array	リソースに割り当てられている単純な文字列のリスト
timeout_client_data	integer	フロントエンドクライアントのタイムアウト時間（ミリ秒単位）
timeout_member_data	integer	バックエンドメンバーのタイムアウト時間（ミリ秒単位）
updated_at	string	リソースの更新日時(UTC)のタイムスタンプ

レスポンス例#

{
    "listeners": [
        {
            "admin_state_up": true,
            "allowed_cidrs": null,
            "connection_limit": -1,
            "created_at": "2019-02-14T01:57:58",
            "default_pool_id": "a2b550fa-12a1-4781-9b3a-2c88cf3bee5c",
            "default_tls_container_ref": null,
            "description": "",
            "id": "89e691bd-f54a-4fd2-bbbc-4ff80d065d89",
            "insert_headers": {},
            "l7policies": [],
            "loadbalancers": [
                {
                    "id": "3bd3e1bb-bde8-410c-b77e-4c6281c2755e"
                }
            ],
            "name": "Listener_tcp",
            "operating_status": "ONLINE",
            "project_id": "51ed616c4bf0440ab6cfe5ff96edce91",
            "protocol": "TCP",
            "protocol_port": 22,
            "provisioning_status": "ACTIVE",
            "sni_container_refs": [],
            "tags": [],
            "timeout_client_data": 50000,
            "timeout_member_data": 50000,
            "updated_at": "2019-02-18T08:39:19"
        }
    ]
}