Create Listener#

リスナーを作成します。

APIエンドポイント#

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

HTTPメソッドとURI#

POST

/v2.0/lbaas/listeners

HTTPステータスコード#

正常時：201

エラー時：400, 401, 403, 404, 409, 500, 503

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

名前	In	Type	デフォルト値 /必須指定	Description
admin_state_up	body	boolean	true 任意	リソースの管理状態「true」または「false」を指定します。
connection_limit	body	integer	-1 任意	リスナーに許可されているコネクションの上限デフォルトは-1です(1000000コネクションになります)。
default_pool_id	body	uuid	任意	マッチするL7ポリシーがない場合に、リスナーが利用するプールのID
default_tls_container_ref	body	string	任意	参照するTLSシークレットコンテナのURL プロトコルがTERMINATED_HTTPSの場合に指定します。
description	body	string	任意	リソースの説明
insert_headers	body	object	任意	バックエンドのメンバーに送信する際挿入されるオプションヘッダのオブジェクト「X-Forwarded-For」、「X-Forwarded-Port」が含まれます。
listeners	body	object	必須	リスナーオブジェクト
loadbalancer_id	body	uuid	必須	ロードバランサーID
name	body	string	任意	リソース名
project_id	body	string	任意	プロジェクトID
protocol	body	string	必須	プロトコル「HTTP」、「HTTPS」、「TCP」または「TERMINATED_HTTPS」を指定します。
protocol_port	body	integer	必須	リスニングするTCPのポート番号
sni_container_refs	body	array	任意	参照するTLSシークレットコンテナのURLの一覧

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

名前	Type	Description
admin_state_up	boolean	リソースの管理状態「true」または「false」が表示されます。
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 policy IDの一覧
listener	object	リスナーオブジェクト
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」または「ERROR」が表示されます。 provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。
sni_container_refs	array	参照するTLSシークレットコンテナのURLの一覧
updated_at	string	リソースの更新日時(UTC)のタイムスタンプ

リクエスト例#

{
	"listener":{
		"connection_limit": 10000, 
		"loadbalancer_id":"7a0cdb82-3920-4a38-964a-26cc7178a086",
		"name":"listener_http",
		"protocol":"HTTP",
		"protocol_port":80,
		"insert_headers":{
			"X-Forwarded-For":"true",
			"X-Forwarded-Port":"true"
		}
	}
}

レスポンス例#

{
    "listener": {
        "admin_state_up": true,
        "connection_limit": 10000,
        "created_at": "2019-03-19T08:06:09",
        "default_pool_id": null,
        "default_tls_container_ref": null,
        "description": "",
        "id": "5bbccd84-ef3d-489b-9631-f6fda6fbd8dd",
        "insert_headers": {
            "X-Forwarded-For": "true",
            "X-Forwarded-Port": "true"
        },
        "l7policies": [],
        "loadbalancers": [
            {
                "id": "7a0cdb82-3920-4a38-964a-26cc7178a086"
            }
        ],
        "name": "listener_http",
        "operating_status": "OFFLINE",
        "project_id": "51ed616c4bf0440ab6cfe5ff96edce91",
        "protocol": "HTTP",
        "protocol_port": 80,
        "provisioning_status": "PENDING_CREATE",
        "sni_container_refs": [],
        "updated_at": null
    }
}