Update a listener

リスナーを更新します。

📒注: 本APIは非推奨です。「Update a Listener」をご利用ください。

APIエンドポイント

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

HTTPメソッドとURI

PUT

/v2.0/lbaas/listeners/{listener_id}

HTTPステータスコード

正常時：202

エラー時：401, 404, 422

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

名前	In	Type	デフォルト値 /必須指定	Description
admin_state_up	body	boolean	任意 true	リソースの管理状態 「up(true)」または「down(false)」が表示されます。
connection_limit	body	integer	任意 -1	リスナーの許可されているコネクション数の上限 デフォルトは-1です(上限なし)。
default_tls_container_ref	body	string	任意	参照するTLSシークレットのコンテナ 注: 通信プロトコルにTERMINATED_HTTPSを指定したリスナーだけは、TLSシークレットのコンテナを指定できます。 TLSシークレットのコンテナを指定する場合は、鍵情報コンテナの作成API（Create a container）のレスポンスパラメーター（container_ref）のURLを指定してください。
description	body	string	任意	リソースの説明
listener	body	object	必須	リスナーオブジェクト
listener_id	path	string	必須	リスナーID
name	body	string	任意	リソース名
sni_container_refs	body	array	任意	参照するTLSシークレットの一覧

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

名前	Type	Description
admin_state_up	boolean	リソースの管理状態 「up(true)」または「down(false)」が表示されます。
connection_limit	integer	リスナーの許可されているコネクション数の上限 デフォルトは-1です(上限なし)。
default_pool_id	string	デフォルトプールのプールID デフォルトプールには、リスナーと対応するプロトコルが設定されている必要があります。
default_tls_container_ref	string	参照するTLSシークレットのコンテナ
description	string	リソースの説明
id	string	ロードバランサーID
listener	body	リスナーオブジェクト
loadbalancers	array	ロードバランサーオブジェクトの一覧
name	string	リソース名
project_id	string	プロジェクトID
protocol	body	プロトコル 「icmp」、「tcp」、「udp」または「null」です。
protocol_port	Integer	リスニングするTCPまたはUDPポート番号
sni_container_refs	body	参照するTLSシークレットの一覧
tenant_id	string	プロジェクトID

リクエスト例

{
    "listener": {
        "admin_state_up": false,
        "connection_limit": 200,
        "description": "listener two",
        "name": "listener2",
        "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
        "sni_container_refs": [
            "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
            "https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
        ]
    }
}

レスポンス例

{
    "listener": {
        "admin_state_up": false,
        "connection_limit": 200,
        "default_pool_id": null,
        "description": "listener two",
        "id": "39de4d56-d663-46e5-85a1-5b9d5fa17829",
        "loadbalancers": [
            {
                "id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c"
            }
        ],
        "name": "listener2",
        "protocol": "HTTP",
        "protocol_port": 80,
        "project_id": "1a3e005cf9ce40308c900bcb08e5320c",
        "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
        "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
        "sni_container_refs": [
            "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
            "https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
        ]
    }
}

📒注: 本APIによる更新処理は非同期で動作するため、レスポンスボディには更新前の値が返ります。更新後の値を確認するためには、リスナーの詳細情報を表示するAPI（Show listener details）を利用します。値の更新に時間を要する可能性もありますので、その場合は詳細情報を値が更新されるまで繰り返し取得してください。