Update pool#
既存のプールを更新します。
📒注: 本APIは非推奨です。「Update a Pool」をご利用ください。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://networking.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://networking.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PUT
/v2.0/lbaas/pools/{pool_id}
HTTPステータスコード#
正常時:202
エラー時:401, 404, 422
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| admin_state_up | body | boolean | 任意 | リソースの管理状態 「true」または「false」を指定します。 |
| cookie_name | body | string | 任意 | セッション維持ポリシーに"APP_COOKIE"を指定する場合にクッキー名を指定します。 |
| description | body | string | 任意 | リソースの説明 |
| lb_algorithm | body | string | 任意 | プールの負荷分散アルゴリズム 「LEAST_CONNECTIONS」、「ROUND_ROBIN」、または「SOURCE_IP」を指定します。 |
| name | body | string | 任意 | リソース名 |
| pool | body | object | 必須 | プールオブジェクト |
| pool_id | path | string | 必須 | プール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 | クッキー名 未設定の場合は、「null」です。 |
| description | string | リソースの説明 |
| healthmonitor_id | string | プールに関連付けられたヘルスモニタのID 未割当時は「null」です。 |
| id | string | プールID |
| lb_algorithm | string | プールの負荷分散アルゴリズム 「LEAST_CONNECTIONS」、「ROUND_ROBIN」、または「SOURCE_IP」のどれかが表示されます。 |
| listeners | array | リスナーの一覧 |
| loadbalancers | array | ロードバランサーの一覧 |
| members | array | メンバーの一覧 |
| name | string | リソース名 |
| pool | object | プールオブジェクト |
| protocol | string | 「HTTP」、「HTTPS」、または「TCP」のどれかが表示されます。 |
| session_presistence | object | セッション維持ポリシーオブジェクト |
| tenant_id | string | プロジェクトID |
| type | string | セッション維持ポリシーのポリシータイプ 「APP_COOKIE」、「HTTP_COOKIE」、または「SOURCE_IP」のどれかが表示されます。 未設定の場合は、「null」です。 |
リクエスト例#
{ "pool":{ "session_persistence":{"type": "SOURCE_IP"} } }
レスポンス例#
{ "pool": { "admin_state_up": true, "description": "", "healthmonitor_id": null, "id": "2b061cb8-feb7-4ca3-b21e-0e2ee810785e", "lb_algorithm": "ROUND_ROBIN", "listeners": [ { "id": "33ad7b6c-fa68-419e-a008-d07acd138289" } ], "loadbalancers": [ { "id": "cce16d58-88e9-46d4-9c87-ac2535785799" } ], "members": [], "name": "Pool_http", "protocol": "HTTP", "session_persistence": { "cookie_name": null, "type": "SOURCE_IP" }, "tenant_id": "d56800ea212148349e084ce559db278f" } }
📒注: 本APIによる更新処理は非同期で動作するため、レスポンスボディには更新前の値が返ります。更新後の値を確認するためには、プールの詳細情報を表示するAPI(Show pool details)を利用します。値の更新に時間を要する可能性もありますので、その場合は詳細情報を値が更新されるまで繰り返し取得してください。