更新时间:2024-01-23 GMT+08:00

更新负载均衡器

功能介绍

更新负载均衡器。

调用方法

请参见如何调用API

URI

PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

表1 路径参数

参数

是否必选

参数类型

描述

loadbalancer_id

String

负载均衡器ID。

最小长度:0

最大长度:36

project_id

String

负载均衡器所在的项目ID。

最小长度:0

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM鉴权Token。

最小长度:0

最大长度:4096

表3 请求Body参数

参数

是否必选

参数类型

描述

loadbalancer

UpdateLoadBalancerOption object

负载均衡器对象。

表4 UpdateLoadBalancerOption

参数

是否必选

参数类型

描述

name

String

负载均衡器的名称。

最小长度:0

最大长度:255

admin_state_up

Boolean

负载均衡器的启用状态,true表示启用,false表示停用。只能设置为true。

description

String

负载均衡器的描述。

最小长度:0

最大长度:255

ipv6_vip_virsubnet_id

String

双栈类型负载均衡器所在子网的IPv6网络ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。

通过更新ipv6_vip_virsubnet_id可以更新负载均衡器所在IPv6子网,且负载均衡器的内网IPv6地址将发生变化。

使用说明:

  • ipv6_vip_virsubnet_id 对应的子网必须属于当前负载均衡器所在VPC,且子网需开启支持IPv6。

  • 只有guaranteed是true的负载均衡器才支持更新ipv6_vip_virsubnet_id。

  • 传入为null表示解绑IPv6子网。

  • 更新IPv6子网不会导致IPv4子网发生变化。

vip_subnet_cidr_id

String

负载均衡器所在的IPv4子网ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id得到。

通过更新vip_subnet_cidr_id可以更新负载均衡器所在IPv4子网,并且负载均衡器的内网IPv4地址将发生变化。

使用说明:

  • 若同时设置了vip_address,则必须保证vip_address对应的IP在vip_subnet_cidr_id的子网网段中。

  • vip_subnet_cidr_id对应的子网必须属于当前负载均衡器vpc_id对应的VPC。

  • 只有guaranteed是true的负载均衡器才支持更新vip_subnet_cidr_id。

  • 传入null表示解绑IPv4子网。

  • 更新IPv子网不会导致IPv4子网发生变化。

最小长度:1

最大长度:36

vip_address

String

负载均衡器的IPv4虚拟IP。该地址必须包含在所在子网的IPv4网段内,且未被占用。

注:仅当guaranteed是true的场合,才支持更新。

最小长度:1

最大长度:36

l4_flavor_id

String

网络型规格ID。

使用说明:

  • 可以通过GET https://{ELB_Endpoint}/v3/{project_id}/flavors?type=L4 响应参数中的id得到。

  • 仅当guaranteed是true的场合,才支持更新。

  • 不允许非null变成null,null变成非null,即不配置七层规格和配置七层规格之间不允许切换;

  • 可以支持规格改大改小,注意改小过程中可能会造成部分长连接中断,影响部分链接的新建,

  • autoscaling.enable=true时,修改无意义,不生效。

  • 当传入的规格类型为L4,表示该实例为固定规格实例,按规格计费。

  • 当传入的规格类型为L4_elastic_max,表示该实例为弹性实例,按LCU计费。

最小长度:1

最大长度:255

l7_flavor_id

String

应用型ID。

使用说明:

  • 可以通过GET https://{ELB_Endpoint}/v3/{project_id}/flavors?type=L7 响应参数中的id得到。

  • 仅当guaranteed是true的场合,才支持更新。

  • 不允许非null变成null,null变成非null,即不配置七层规格和配置七层规格之间不允许切换;

  • 可以支持规格改大改小,注意改小过程中可能会造成部分长连接中断,影响部分链接的新建,

  • autoscaling.enable=true时,修改无意义,不生效。

  • 当传入的规格类型为L7,表示该实例为固定规格实例,按规格计费。

  • 当传入的规格类型为L7_elastic_max,表示该实例为弹性实例,按LCU计费。

最小长度:1

最大长度:36

ipv6_bandwidth

BandwidthRef object

带宽对象ID,仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时,此EIP会被分进共享带宽里面。

ip_target_enable

Boolean

是否启用跨VPC后端转发。

开启跨VPC后端转发后,后端服务器组不仅支持添加云上VPC内的服务器,还支持添加其他VPC、其他公有云、云下数据中心的服务器。

使用共享VPC的实例使用此特性时,需确保共享资源所有者已开通VPC对等连接,否则通信异常。

仅独享型负载均衡器支持该特性。

取值:

  • true:开启。

  • false:不开启。

使用说明:

  • 开启不能关闭。

elb_virsubnet_ids

Array of strings

下联面子网的网络ID列表。 可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets

响应参数中的neutron_network_id得到。

已绑定的下联面子网也在传参elb_virsubnet_ids列表中,则绑定关系保留。

已绑定的下联面子网若不在传参elb_virsubnet_ids列表中, 则将移除LB与该下联面子网的关联关系。但不允许移除已被ELB使用的子网,否则将报错,不做任何修改。

在传参elb_virsubnet_ids列表中但不在已绑定的下联面子网列表中,则将新增LB与下联面的绑定关系。

使用说明:

  • 所有ID同属于该LB所在的VPC。

  • 不支持边缘云子网。

最小长度:1

最大长度:64

数组长度:0 - 64

deletion_protection_enable

Boolean

是否开启删除保护。

取值:false不开启,true开启。

说明:

退场时需要先关闭所有资源的删除保护开关。

autoscaling

UpdateLoadbalancerAutoscalingOption object

弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。

使用说明:

  • 仅当租户白名单放开后该字段才有效

  • 开启弹性扩缩容后,l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。

该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。

charge_mode

String

计费模式。

取值:

  • flavor:按规格计费

protection_status

String

修改保护状态, 取值:

  • nonProtection: 不保护

  • consoleProtection: 控制台修改保护

protection_reason

String

设置保护的原因

说明:

仅当protection_status为consoleProtection时有效。

最小长度:0

最大长度:255

ipv6_vip_address

String

双栈类型负载均衡器的IPv6地址。

表5 BandwidthRef

参数

是否必选

参数类型

描述

id

String

共享带宽的id

表6 UpdateLoadbalancerAutoscalingOption

参数

是否必选

参数类型

描述

enable

Boolean

当前负载均衡器是否开启弹性扩缩容。

取值:

  • true:开启。

  • false:不开启。

缺省值:false

min_l7_flavor_id

String

弹性扩缩容的最小七层规格ID(规格类型L7_elastic),有七层监听器时,该字段不能为空。

该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。

最小长度:1

最大长度:36

响应参数

状态码: 200

表7 响应Body参数

参数

参数类型

描述

loadbalancer

LoadBalancer object

负载均衡器对象。

loadbalancer_id

String

负载均衡器的id

最小长度:0

最大长度:36

order_id

String

订单号

最小长度:0

最大长度:36

request_id

String

请求ID。

注:自动生成 。

最小长度:0

最大长度:36

表8 LoadBalancer

参数

参数类型

描述

id

String

负载均衡器ID。

description

String

负载均衡器描述信息。

最小长度:1

最大长度:255

provisioning_status

String

负载均衡器的配置状态。

取值:

  • ACTIVE:使用中。

  • PENDING_DELETE:删除中。

admin_state_up

Boolean

负载均衡器的启用状态。取值:false停用,true启用。

provider

String

负载均衡器的生产者名称。固定为vlb。

pools

Array of PoolRef objects

负载均衡器直接关联的后端云服务器组的ID列表。

listeners

Array of ListenerRef objects

负载均衡器关联的监听器的ID列表。

operating_status

String

负载均衡器的操作状态。

取值:

  • ONLINE:在线。

name

String

负载均衡器的名称。

project_id

String

负载均衡器所属的项目ID。

vip_subnet_cidr_id

String

负载均衡器所在子网的IPv4子网ID。

vip_address

String

负载均衡器的IPv4虚拟IP地址。

vip_port_id

String

负载均衡器的IPv4对应的port ID。

tags

Array of Tag objects

负载均衡的标签列表。

created_at

String

负载均衡器的创建时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z'

updated_at

String

负载均衡器的更新时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z'

guaranteed

Boolean

是否独享型LB。

取值:

  • false:共享型。

  • true:独享型。

vpc_id

String

负载均衡器所在VPC ID。

eips

Array of EipInfo objects

负载均衡器绑定的EIP。只支持绑定一个EIP。

注:该字段与publicips一致。

ipv6_vip_address

String

双栈类型负载均衡器的IPv6地址。

ipv6_vip_virsubnet_id

String

双栈类型负载均衡器所在子网的IPv6网络ID。

ipv6_vip_port_id

String

双栈类型负载均衡器的IPv6对应的port ID。

availability_zone_list

Array of strings

负载均衡器所在的可用区列表。

enterprise_project_id

String

企业项目ID。创建时不传则返回"0",表示资源属于default企业项目。

注:"0"并不是真实存在的企业项目ID,在创建、更新和查询时不能作为请求参数传入。

billing_info

String

资源账单信息。

取值:

  • 空:按需计费。

最小长度:1

最大长度:1024

l4_flavor_id

String

网络型规格ID。

对于弹性扩缩容实例,表示上限规格。

当传入的规格类型为L4,表示该实例为固定规格实例,按规格计费; 当传入的规格类型为L4_elastic_max,表示该实例为弹性实例,按LCU计费

最小长度:1

最大长度:255

l4_scale_flavor_id

String

四层弹性Flavor ID。

不支持该字段,请勿使用。

最小长度:1

最大长度:255

l7_flavor_id

String

应用型ID。 对于弹性扩缩容实例,表示上限规格ID。

当传入的规格类型为L7,表示该实例为固定规格实例,按规格计费; 当传入的规格类型为L7_elastic_max,表示该实例为弹性实例,按LCU计费

最小长度:1

最大长度:255

l7_scale_flavor_id

String

七层弹性Flavor ID。

不支持该字段,请勿使用。

最小长度:1

最大长度:255

publicips

Array of PublicIpInfo objects

负载均衡器绑定的公网IP。只支持绑定一个公网IP。

注:该字段与eips一致。

global_eips

Array of GlobalEipInfo objects

负载均衡器绑定的global eip。只支持绑定一个globaleip。

elb_virsubnet_ids

Array of strings

下联面子网的网络ID列表。

elb_virsubnet_type

String

下联面子网类型

  • ipv4:ipv4

  • dualstack:双栈

ip_target_enable

Boolean

是否启用跨VPC后端转发。

开启跨VPC后端转发后,后端服务器组不仅支持添加云上VPC内的服务器,还支持添加其他VPC、其他公有云、云下数据中心的服务器。

使用共享VPC的实例使用此特性时,需确保共享资源所有者已开通VPC对等连接,否则通信异常。 仅独享型负载均衡器支持该特性。

取值:

  • true:开启。

  • false:不开启。

使用说明:

  • 开启不能关闭。

frozen_scene

String

负载均衡器的冻结场景。 若负载均衡器有多个冻结场景,用逗号分隔。

取值:

  • POLICE:公安冻结场景。

  • ILLEGAL:违规冻结场景。

  • VERIFY:客户未实名认证冻结场景。

  • PARTNER:合作伙伴冻结(合作伙伴冻结子客户资源)。

  • AREAR:欠费冻结场景。

ipv6_bandwidth

BandwidthRef object

带宽对象ID,仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时,此EIP会被分进共享带宽里面。

deletion_protection_enable

Boolean

是否开启删除保护。

取值:

  • false:不开启。

  • true:开启。

说明:

退场时需要先关闭所有资源的删除保护开关。

仅当前局点启用删除保护特性后才会返回该字段。

autoscaling

AutoscalingRef object

弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。

使用说明:

  • 仅当租户白名单放开后该字段才有效

  • 开启弹性扩缩容后,l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。

该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。

public_border_group

String

LB所属AZ组

charge_mode

String

收费模式。取值:

  • flavor:按规格计费

  • lcu:按使用量计费

waf_failure_action

String

WAF故障时的流量处理策略。discard:丢弃,forward: 转发到后端(默认)

使用说明:只有绑定了waf的LB实例,该字段才会生效。

不支持该字段,请勿使用。

protection_status

String

修改保护状态, 取值:

  • nonProtection: 不保护,默认值为nonProtection

  • consoleProtection: 控制台修改保护

protection_reason

String

设置保护的原因

说明:

仅当protection_status为consoleProtection时有效。

最小长度:0

最大长度:255

log_group_id

String

LB所绑定的logtank对应的group id

log_topic_id

String

LB所绑定的logtank对应的topic id

表9 PoolRef

参数

参数类型

描述

id

String

后端服务器组ID。

表10 ListenerRef

参数

参数类型

描述

id

String

监听器ID。

表11 Tag

参数

参数类型

描述

key

String

标签键

最小长度:1

最大长度:36

value

String

标签值

最小长度:0

最大长度:43

表12 EipInfo

参数

参数类型

描述

eip_id

String

eip_id

eip_address

String

eip_address

ip_version

Integer

IP版本号。

取值:4表示IPv4,6表示IPv6。

表13 PublicIpInfo

参数

参数类型

描述

publicip_id

String

弹性公网ip配置id

publicip_address

String

IP地址

ip_version

Integer

IP版本信息。 取值范围:4和6 4:IPv4 6:IPv6

表14 GlobalEipInfo

参数

参数类型

描述

global_eip_id

String

global eip的id

global_eip_address

String

global eip的ip地址

ip_version

Integer

IP版本信息。 取值范围:4和6 4:IPv4 6:IPv6

表15 BandwidthRef

参数

参数类型

描述

id

String

共享带宽的id

表16 AutoscalingRef

参数

参数类型

描述

enable

Boolean

当前负载均衡器是否开启弹性扩缩容。

取值:

  • true:开启。

  • false:不开启,默认值。

min_l7_flavor_id

String

弹性扩缩容的最小七层规格ID(规格类型L7_elastic),有七层监听器时,该字段不能为空。

该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。

最小长度:1

最大长度:36

请求示例

更新负载均衡器的描述和名称

PUT https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

{
  "loadbalancer" : {
    "description" : "loadbalancer",
    "name" : "loadbalancer-update"
  }
}

响应示例

状态码: 200

操作正常返回。

{
  "request_id" : "010dad1e-32a3-4405-ab83-62a1fc5f8722",
  "loadbalancer" : {
    "id" : "2e073bf8-edfe-4e51-a699-d915b0b8af89",
    "project_id" : "b2782e6708b8475c993e6064bc456bf8",
    "name" : "loadbalancer-update",
    "description" : "loadbalancer",
    "vip_port_id" : null,
    "vip_address" : null,
    "admin_state_up" : true,
    "provisioning_status" : "ACTIVE",
    "operating_status" : "ONLINE",
    "listeners" : [ {
      "id" : "41937176-bf64-4b58-8e0d-9ff2d0d32c54"
    }, {
      "id" : "abc6ac93-ad0e-4765-bd5a-eec632efde56"
    }, {
      "id" : "b9d8ba97-6d60-467d-838d-f3550b54c22a"
    }, {
      "id" : "fd797ebd-263d-4b18-96e9-e9188d36c69e"
    } ],
    "pools" : [ {
      "id" : "0aabcaa8-c35c-4ddc-a60c-9032d0ac0b80"
    }, {
      "id" : "165d9092-396e-4a8d-b398-067496a447d2"
    } ],
    "tags" : [ ],
    "provider" : "vlb",
    "created_at" : "2019-04-20T03:10:37Z",
    "updated_at" : "2019-05-24T02:11:58Z",
    "vpc_id" : "2037c5bb-e04b-4de2-9300-9051af18e417",
    "enterprise_project_id" : "0",
    "availability_zone_list" : [ "AZ1", "AZ2", "dc3" ],
    "ipv6_vip_address" : null,
    "ipv6_vip_virsubnet_id" : null,
    "ipv6_vip_port_id" : null,
    "eips" : [ ],
    "guaranteed" : true,
    "billing_info" : null,
    "l4_flavor_id" : null,
    "l4_scale_flavor_id" : null,
    "l7_flavor_id" : null,
    "l7_scale_flavor_id" : null,
    "vip_subnet_cidr_id" : null,
    "deletion_protection_enable" : false,
    "public_border_group" : "center"
  }
}

SDK代码示例

SDK代码示例如下。

更新负载均衡器的描述和名称

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;


public class UpdateLoadBalancerSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateLoadBalancerRequest request = new UpdateLoadBalancerRequest();
        UpdateLoadBalancerRequestBody body = new UpdateLoadBalancerRequestBody();
        UpdateLoadBalancerOption loadbalancerbody = new UpdateLoadBalancerOption();
        loadbalancerbody.withName("loadbalancer-update")
            .withDescription("loadbalancer");
        body.withLoadbalancer(loadbalancerbody);
        request.withBody(body);
        try {
            UpdateLoadBalancerResponse response = client.updateLoadBalancer(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

更新负载均衡器的描述和名称

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateLoadBalancerRequest()
        loadbalancerbody = UpdateLoadBalancerOption(
            name="loadbalancer-update",
            description="loadbalancer"
        )
        request.body = UpdateLoadBalancerRequestBody(
            loadbalancer=loadbalancerbody
        )
        response = client.update_load_balancer(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

更新负载均衡器的描述和名称

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateLoadBalancerRequest{}
	nameLoadbalancer:= "loadbalancer-update"
	descriptionLoadbalancer:= "loadbalancer"
	loadbalancerbody := &model.UpdateLoadBalancerOption{
		Name: &nameLoadbalancer,
		Description: &descriptionLoadbalancer,
	}
	request.Body = &model.UpdateLoadBalancerRequestBody{
		Loadbalancer: loadbalancerbody,
	}
	response, err := client.UpdateLoadBalancer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码