Update a load balancer#

ロードバランサーを更新します。

📒注: 本APIは非推奨です。[「Update a Load Balancer」をご利用ください。

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/loadbalancers/{loadbalancer_id}

HTTPステータスコード#

正常時：202

エラー時：400, 401, 404

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

名前	In	Type	デフォルト値 /必須指定	Description
admin_state_up	body	boolean	任意 true	リソースの管理状態「up(true)」または「down(false)」が表示されます。
description	body	string	任意 null	リソースの説明
loadbalancer	body	object	必須	ロードバランサーオブジェクト
loadbalancer_id	path	string	必須	ロードバランサーID
name	body	string	任意 null	リソース名

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

名前	Type	Description
admin_state_up	boolean	リソースの管理状態「up(true)」または「down(false)」が表示されます。
description	string	リソースの説明
flavor	string	フレーバーID
id	string	ロードバランサーID
listeners	array	関連付けられているリスナーのID（存在する場合）
loadbalancer	object	ロードバランサーオブジェクト
name	string	リソース名
operating_status	string	リソースの運用状況「ONLINE」または「OFFLINE」です。
pools	array	プールオブジェクトの一覧
project_id	string	プロジェクトID
provider	string	ロードバランサーの提供者の名前
provisioning_status	string	リソースの提供状況「ACTIVE」、「PENDING_CREATE」または「ERROR」です。
tenant_id	string	プロジェクトID
vip_subnet_id	string	仮想IP(VIP)のサブネットのID
vip_network_id	string	仮想IP(VIP)のネットワークID

リクエスト例#

{
    "loadbalancer": {
        "admin_state_up": false,
        "description": "simple lb2",
        "name": "loadbalancer2"
    }
}

レスポンス例#

{
    "loadbalancer": {
        "admin_state_up": false,
        "description": "simple lb2",
        "id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c",
        "listeners": [],
        "name": "loadbalancer2",
        "operating_status": "ONLINE",
        "provisioning_status": "PENDING_UPDATE",
        "project_id": "b7c1a69e88bf4b21a8148f787aef2081",
        "tenant_id": "b7c1a69e88bf4b21a8148f787aef2081",
        "vip_address": "10.0.0.4",
        "vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
        "flavor": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04",
        "provider": "sample_provider",
        "pools": []
    }
}

📒注: 本APIによる更新処理は非同期で動作するため、レスポンスボディには更新前の値が返ります。更新後の値を確認するためには、ロードバランサーの詳細情報を表示するAPI（Show load balancer details）を利用します。値の更新に時間を要する可能性もありますので、その場合は詳細情報を値が更新されるまで繰り返し取得してください。