List listeners#
プロジェクトのリスナーを一覧表示します。
📒注: 本APIは非推奨です。「List Listeners」をご利用ください。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://networking.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://networking.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v2.0/lbaas/listeners/
HTTPステータスコード#
正常時:200
エラー時:401
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| fields | query | string | 任意 | 属性を指定します。 省略した場合は、すべての属性が表示されます。 複数指定ができます。 例えば、 fields=id&fields=nameと指定すると、「id」と「name」の属性だけが表示されます。 |
レスポンスボディ(正常系)の説明#
| 名前 | 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 |
| listeners | array | リスナーオブジェクトの一覧 |
| loadbalancers | array | ロードバランサーオブジェクトの一覧 |
| name | string | リソース名 |
| project_id | string | プロジェクトID |
| protocol | string | プロトコル 「icmp」、「tcp」、「udp」または「null」のどれかを指定します。 |
| protocol_port | integer | リスニングするTCPまたはUDPポート番号 |
| sni_container_refs | array | 参照するTLSシークレットの一覧 |
| tenant_id | string | プロジェクトID |
レスポンス例#
{ "listeners": [ { "admin_state_up": true, "connection_limit": 100, "default_pool_id": null, "description": "", "id": "35cb8516-1173-4035-8dae-0dae3453f37f", "loadbalancers": [ { "id": "a9729389-6147-41a3-ab22-a24aed8692b2" } ], "name": "", "protocol": "HTTP", "protocol_port": 80, "project_id": "3e4d8bec50a845fcb09e03a4375c691d", "tenant_id": "3e4d8bec50a845fcb09e03a4375c691d", "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" ] } ] }