List Pools#

プロジェクトのプールを一覧表示します。

APIエンドポイント#

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

HTTPメソッドとURI#

GET

/v2.0/lbaas/pools

HTTPステータスコード#

正常時：200

エラー時：400,401,500

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

名前	In	Type	デフォルト値 /必須指定	Description
fields	query	string	任意	属性を指定します。省略した場合は、すべての属性が表示されます。複数指定ができます。例えば、fields=id&fields=nameと指定すると、「id」と「name」の属性だけが表示されます。

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

名前	Type	Description
admin_state_up	boolean	リソースの管理状態「true」または「false」が表示されます。
cookie_name	string	セッション維持のtypeに「APP_COOKIE」を指定した場合にクッキー名が表示されます。
created_at	string	リソースが作成された日時(UTC)のタイムスタンプ
description	string	リソースの説明
healthmonitor_id	uuid	関連付けられたヘルスモニターID
id	uuid	プールID
lb_algorithm	string	プールの負荷分散アルゴリズム「LEAST_CONNECTIONS」、「ROUND_ROBIN」または「SOURCE_IP」が表示されます。
listeners	array	リスナーIDの一覧
loadbalancers	array	ロードバランサーIDの一覧
members	array	メンバーIDの一覧
name	string	リソース名
operating_status	string	リソースの運用状況「ONLINE」、「OFFLINE」または「ERROR」が表示されます。 operating_statusの詳細は「Operating Status Codes」を参照してください。
pools	array	プールオブジェクトの一覧
project_id	string	プロジェクトID
protocol	string	プロトコル「HTTP」、「HTTPS」、「TCP」が表示されます。
provisioning_status	string	リソースの提供状況「ACTIVE」、「PENDING_CREATE」、「PENDING_UPDATE」または「ERROR」が表示されます。 provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。
session_persistence	object	セッション維持オブジェクト
type	string	セッション維持のタイプ「APP_COOKIE」、「HTTP_COOKIE」または「SOURCE_IP」が表示されます。
updated_at	string	リソースの更新日時(UTC)のタイムスタンプ

レスポンス例#

{
    "pools": [
        {
            "admin_state_up": true,
            "created_at": "2019-02-14T01:58:00",
            "description": "",
            "healthmonitor_id": "ee0cc170-6444-42a2-8c4a-a25ff10e437b",
            "id": "a2b550fa-12a1-4781-9b3a-2c88cf3bee5c",
            "lb_algorithm": "ROUND_ROBIN",
            "listeners": [
                {
                    "id": "89e691bd-f54a-4fd2-bbbc-4ff80d065d89"
                }
            ],
            "loadbalancers": [
                {
                    "id": "3bd3e1bb-bde8-410c-b77e-4c6281c2755e"
                }
            ],
            "members": [
                {
                    "id": "1bd5ae11-8c7a-4da8-b061-72ec43cf7a10"
                },
                {
                    "id": "eda9aa64-b826-4b30-8613-a0c58f48257d"
                }
            ],
            "name": "Pool_nishi_tu1_tcp",
            "operating_status": "ONLINE",
            "project_id": "51ed616c4bf0440ab6cfe5ff96edce91",
            "protocol": "TCP",
            "provisioning_status": "ACTIVE",
            "session_persistence": null,
            "updated_at": "2019-03-08T02:39:48"
        }
    ]
}