List pools#
プロジェクト内のプールを一覧表示します。
📒注: 本APIは非推奨です。「List Pools」をご利用ください。
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/pools
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)」が表示されます。 |
description | string | リソースの説明 |
healthmonitors | array | 関連付けられたヘルスモニターの一覧 |
healthmonitors_status | array | ヘルスモニターステータスオブジェクトの一覧 |
id | string | リソースのID |
lb_algorithm | string | プールの負荷分散アルゴリズム 「LEAST_CONNECTIONS」、「ROUND_ROBIN」または「SOURCE_IP」のどれかを指定します。 |
members | array | メンバーの一覧 |
name | string | リソース名 |
pools | array | プールオブジェクトの一覧 |
project_id | string | プロジェクトID |
protocol | string | プロトコル 「ICMP」、「TCP」、「UDP」または「NULL」が表示されます。 |
provider | string | ロードバランサーサービスの提供者 |
subnet_id | string | プールのメンバーを割り当てるサブネット |
status | string | プールの運用状況 |
status_description | string | ステータスの説明 |
tenant_id | string | プロジェクトID |
vip_id | string | 仮想IP(VIP)のIPアドレス |
レスポンス例#
{ "pools": [ { "status": "ACTIVE", "lb_algorithm": "ROUND_ROBIN", "protocol": "HTTP", "description": "", "healthmonitors": [ "b7633ade-24dc-4d72-8475-06aa22be5412" ], "members": [ "cf024846-7516-4e3a-b0fb-6590322c836f" ], "status_description": null, "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba", "name": "pool1", "admin_state_up": true, "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b", "project_id": "eabfefa3fd1740a88a47ad98e132d238", "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", "healthmonitors_status": [ { "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412", "status": "ACTIVE", "status_description": null } ], "provider": "haproxy" } ] }