Create listener#
リスナーを作成します。
📒注: 本APIは非推奨です。「Create 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#
POST
/v2.0/lbaas/listeners
HTTPステータスコード#
正常時:201
エラー時:400, 401, 404
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| admin_state_up | body | boolean | 任意 true |
リソースの管理状態 「up(true)」または「down(false)」です。 |
| connection_limit | body | integer | 任意 -1 |
許可されているコネクション数の上限 上限なしの場合は-1とします。 |
| default_pool_id | body | String | 任意 | デフォルトプールのプールID デフォルトプールには、リスナーと対応するプロトコルが設定されている必要があります。 |
| default_tls_container_ref | body | String | 任意 | 参照するTLSシークレットのコンテナ 📒注: TLSシークレットのコンテナを指定する場合は、鍵情報コンテナの作成API(Create a container)の レスポンスパラメーター(container_ref)のURLを指定してください。 |
| description | body | string | 任意 | リソースの説明 |
| listener | body | object | 必須 | リスナーオブジェクト |
| loadbalancer_id | body | string | 必須 | ロードバランサーID |
| name | body | string | 任意 | リソース名 |
| project_id | body | string | 任意 | プロジェクトID(非推奨) |
| protocol | body | integer | 必須 | プロトコル 「HTTP」、「HTTPS」、「TCP」または「TERMINATED_HTTPS」のどれかが指定できます。 📒注:default_tls_container_refにTLSシークレットのコンテナを指定する場合は、protocolにはTERMINATED_HTTPSを指定してください。 |
| protocol_port | body | integer | 必須 | リスニングするTCPまたはUDPポート番号 |
| sni_container_refs | body | array | 任意 | 参照するTLSシークレットの一覧 |
| tenant_id | body | string | 任意 | プロジェクトID |
レスポンスボディ(正常系)の説明#
| 名前 | 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 | array | 参照するTLSシークレットの一覧 |
| tenant_id | string | プロジェクトID |
リクエスト例#
{ "listener": { "admin_state_up": true, "connection_limit": 100, "description": "listener one", "loadbalancer_id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c", "name": "listener1", "protocol": "HTTP", "protocol_port": "80", "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": true, "connection_limit": 100, "default_pool_id": null, "description": "listener one", "id": "39de4d56-d663-46e5-85a1-5b9d5fa17829", "loadbalancers": [ { "id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c" } ], "name": "listener1", "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" ] } }