Update a Pool#

プールを更新します。

APIエンドポイント#

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

HTTPメソッドとURI#

PUT

/v2.0/lbaas/pools/{pool_id}

HTTPステータスコード#

正常時：202

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

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

名前	In	Type	デフォルト値 /必須指定	Description
admin_state_up	body	boolean	true 任意	リソースの管理状態「true」または「false」を指定します。
cookie_name	body	string	任意	セッション維持のtypeに「APP_COOKIE」を指定する場合にクッキー名を指定します。
description	body	string	任意	リソースの説明
lb_algorithm	body	string	任意	プールの負荷分散アルゴリズム「LEAST_CONNECTIONS」、「ROUND_ROBIN」または「SOURCE_IP」を指定します。
name	body	string	任意	リソース名
pool	body	object	必須	プールオブジェクト
pool_id	path	uuid	必須	プールID
session_persistence	body	object	任意	セッション維持オブジェクト
type	body	string	任意	セッション維持のタイプ「APP_COOKIE」、「HTTP_COOKIE」または「SOURCE_IP」を指定します。 📒注: 「APP_COOKIE」または「HTTP_COOKIE」はプールのプロトコルが「HTTP」の場合だけ設定可能です。

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

名前	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」を参照してください。
pool	object	プールオブジェクト
project_id	string	プロジェクトID
protocol	string	プロトコル「HTTP」、「HTTPS」または「TCP」が表示されます。
provisioning_status	string	リソースの提供状況「ACTIVE」、「PENDING_CREATE」または「ERROR」が表示されます。 provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。
session_persistence	object	セッション維持オブジェクト
type	string	セッション維持のタイプ「APP_COOKIE」、「HTTP_COOKIE」または「SOURCE_IP」が表示されます。
updated_at	string	リソースの更新日時(UTC)のタイムスタンプ

リクエスト例#

{
    "pool":{
        "description":"Update http_pool_1",
        "session_persistence":{
            "type":"HTTP_COOKIE"
        }
    }
}

レスポンス例#

{
    "pool": {
        "admin_state_up": true,
        "created_at": "2019-03-22T06:24:55",
        "description": "",
        "id": "6e255533-98e5-45d1-aac7-918829cbae38",
        "lb_algorithm": "ROUND_ROBIN",
        "listeners": [
            {
                "id": "5bbccd84-ef3d-489b-9631-f6fda6fbd8dd"
            }
        ],
        "loadbalancers": [
            {
                "id": "7a0cdb82-3920-4a38-964a-26cc7178a086"
            }
        ],
        "members": [],
        "name": "http_pool_1",
        "operating_status": "ONLINE",
        "project_id": "51ed616c4bf0440ab6cfe5ff96edce91",
        "protocol": "HTTP",
        "provisioning_status": "PENDING_UPDATE",
        "session_persistence": null,
        "updated_at": "2019-03-22T07:19:56"
    }
}