更新负载均衡器

功能介绍

更新负载均衡器的名称或描述信息。

URI

PUT /v2.0/lbaas/loadbalancers/{loadbalancer_id}

表1 参数说明
参数	是否必选	参数类型	描述
loadbalancer_id	是	String	负载均衡器ID。

请求消息

表2 请求参数
参数	是否必选	参数类型	描述
loadbalancer	是	Object	负载均衡器对象。详见表3。

表3 loadbalancer字段说明
参数	是否必选	参数类型	描述
name	否	String	负载均衡器名称。支持的最大字符长度：255
description	否	String	负载均衡器描述信息。支持的最大字符长度：255
admin_state_up	否	Boolean	负载均衡器的管理状态。该字段为预留字段，暂未启用。默认为true。

响应消息

表4 响应参数
参数	参数类型	描述
loadbalancer	Object	负载均衡器对象。详见表5。

表5 loadbalancer字段说明
参数	参数类型	描述
id	String	负载均衡器ID。
project_id	String	此参数和tenant_id参数含义一样，均指负载均衡器所在的项目ID。
tenant_id	String	负载均衡器所在项目的ID。支持的最大字符长度：255
name	String	负载均衡器名称。支持的最大字符长度：255
description	String	负载均衡器的描述信息。支持的最大字符长度：255
vip_subnet_id	String	负载均衡器所在子网IPv4子网ID。
vip_port_id	String	负载均衡器内网IP对应的端口ID。创建弹性负载均衡时，会自动为负载均衡创建一个port并关联一个默认的安全组，这个安全组对所有流量不生效。
provider	String	负载均衡器的生产者名称。
vip_address	String	负载均衡器的内网IP。支持的最大字符长度：64
listeners	Array	负载均衡器关联监听器ID的列表。详见表5
pools	Array	负载均衡器关联后端服务器组ID的列表。详见表6
operating_status	String	负载均衡器的操作状态。取值范围：可以为ONLINE和FROZEN。
provisioning_status	String	该字段为预留字段，暂未启用。负载均衡器的配置状态。取值范围：可以为ACTIVE。
admin_state_up	Boolean	负载均衡器的管理状态。该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。
tags	Array	负载均衡器的标签列表。
created_at	String	负载均衡器的创建时间。格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19
updated_at	String	负载均衡器的更新时间。格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19

表6 listeners字段说明
参数	参数类型	描述
id	String	关联的监听器id

表7 pools字段说明
参数	参数类型	描述
id	String	关联的后端服务器组id

请求示例

请求样例更新负载均衡器名称、描述

PUT https://{Endpoint}/v2.0/lbaas/loadbalancers/1e11b74e-30b7-4b78-b09b-84aec4a04487

{
    "loadbalancer": {
        "name": "lb_update_test", 
        "description": "lb update test"
    }
}

响应示例

响应样例

{
  "loadbalancer": {
    "description": "simple lb2",
    "admin_state_up": true,
    "tenant_id": "145483a5107745e9b3d80f956713e6a3",
    "project_id": "145483a5107745e9b3d80f956713e6a3",
    "provisioning_status": "ACTIVE",
    "vip_subnet_id": "823d5866-6e30-45c2-9b1a-a1ebc3757fdb",
    "listeners": [
      {
        "id": "37ffe679-08ef-436e-b6bd-cf66fb4c3de2"
      }
    ],
    "vip_address": "192.172.1.68",
    "vip_port_id": "f42e3019-67f7-4d2a-8d1c-af49e7c22fa6",
    "tags": [],
    "provider": "vlb",
    "pools": [
      {
        "id": "75c4f2d4-a213-4408-9fa8-d64708e8d1df"
      }
    ],
    "id": "c32a9f9a-0cc6-4f38-bb9c-cde79a533c19",
    "operating_status": "ONLINE",
    "name": "loadbalancer-test2",
    "created_at": "2018-07-25T01:54:13", 
    "updated_at": "2018-07-25T01:54:14"
  }
}