更新时间:2022-03-31 GMT+08:00
分享

更新负载均衡器

功能介绍

更新负载均衡器。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

loadbalancer_id

String

负载均衡器ID。

最小长度:0

最大长度:36

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM鉴权Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

loadbalancer

UpdateLoadBalancerOption object

负载均衡器对象。

表4 UpdateLoadBalancerOption

参数

是否必选

参数类型

描述

name

String

负载均衡器的名称。

最小长度:0

最大长度:255

admin_state_up

Boolean

负载均衡器的管理状态。只能设置为true。

description

String

负载均衡器的描述。

最小长度:0

最大长度:255

ipv6_vip_virsubnet_id

String

双栈类型负载均衡器所在子网的IPv6网络ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的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

四层Flavor ID。

注: 1.仅当guaranteed是true的场合,才支持更新。 2.不允许非null变成null,null变成非null,只允许改大,不允许改小。

hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。

最小长度:1

最大长度:255

l7_flavor_id

String

七层Flavor ID。

注: 1.仅当guaranteed是true的场合,才支持更新。 2.不允许非null变成null,null变成非null;只允许改大,不允许改小。

hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。

最小长度:1

最大长度:36

ipv6_bandwidth

BandwidthRef object

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

ip_target_enable

Boolean

是否启用跨VPC后端转发,开启跨VPC后端转发后,支持添加其他VPC、其他公有云、云下数据中心的服务器。取值: - true:开启。 - false:不开启。 仅独享型负载均衡器支持该特性,且只能更新为true,即开启后不支持关闭。

elb_virsubnet_ids

Array of strings

下联面子网的网络ID列表。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的id得到。

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

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

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

使用说明:

  • 所有ID同属于该LB所在的VPC。
  • 不支持边缘云子网。

最小长度:1

最大长度:64

deletion_protection_enable

Boolean

是否开启删除保护。取值:false不开启,true开启。

说明:

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

prepaid_options

PrepaidUpdateOption object

负载均衡器的包周期规格变更信息

autoscaling

UpdateLoadbalancerAutoscalingOption object

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

使用说明:

  • 仅当局点支持弹性扩缩特性该字段才有效。可咨询客服了解当前局点是否支持弹性扩缩容特性。
  • 开启弹性扩缩容后,l4_flavor_id和l7_flavor_id不再起作用。
表5 BandwidthRef

参数

是否必选

参数类型

描述

id

String

共享带宽的id

表6 PrepaidUpdateOption

参数

是否必选

参数类型

描述

auto_pay

Boolean

下单订购后,是否自动从客户的账户中支付; true:自动支付; false:不自动支付(默认)。 自动支付时,只能使用账户的现金支付;如果要使用代金券,请选择不自动支付,然后在用户费用中心,选择代金券支付。

缺省值:false

change_mode

String

规格变更类型。取值:

  • immediate:即时变更(默认),规格变更立即生效。
  • delay:续费变更,当前周期结束后变更为目标规格。

缺省值:immediate

最小长度:0

最大长度:10

period_num

Integer

订购周期数,仅在change_mode为delay时有效。取值:

  • period_type为month时,为[1,9],默认1。
  • period_type为year时,为[1,3],默认1。

最小值:1

最大值:9

缺省值:1

period_type

String

订购周期类型,仅在change_mode为delay时有效。取值:

  • month:月(默认)。
  • year:年。

缺省值:month

表7 UpdateLoadbalancerAutoscalingOption

参数

是否必选

参数类型

描述

enable

Boolean

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

  • true:开启。
  • false:不开启。

缺省值:false

min_l4_flavor_id

String

弹性扩缩容的最小四层规格ID,有四层监听器时,该字段不能为空。

最小长度:1

最大长度:36

min_l7_flavor_id

String

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

最小长度:1

最大长度:36

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

loadbalancer

LoadBalancer object

负载均衡器对象。(非包周期规格变更场景返回该字段)

loadbalancer_id

String

负载均衡器的id(包周期场景返回该字段)

最小长度:0

最大长度:36

order_id

String

订单号(包周期规格变更场景返回该字段)

最小长度:0

最大长度:36

request_id

String

请求ID。

注:自动生成 。

最小长度:0

最大长度:36

表9 LoadBalancer

参数

参数类型

描述

id

String

负载均衡器ID。

description

String

负载均衡器描述信息。

最小长度:1

最大长度:255

provisioning_status

String

负载均衡器的配置状态。取值:

  • ACTIVE:使用中。
  • PENDING_DELETE:删除中。

admin_state_up

Boolean

负载均衡器的管理状态。固定为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

billing_info

String

资源账单信息。 取值:

  • 空:按需计费。
  • 非空:包周期计费,

包周期计费billing_info字段的格式为:order_id:product_id:region_id:project_id,如:

CS2107161019CDJZZ:OFFI569702121789763584:eu-de:057ef081eb00d2732fd1c01a9be75e6f

使用说明:

  • admin权限才能更新此字段。

最小长度:1

最大长度:1024

l4_flavor_id

String

四层Flavor ID。

hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。

最小长度:1

最大长度:255

l4_scale_flavor_id

String

四层弹性Flavor ID。

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

最小长度:1

最大长度:255

l7_flavor_id

String

七层Flavor ID。

hcso场景下所有LB实例共享带宽,该字段无效,请勿使用。

最小长度:1

最大长度:255

l7_scale_flavor_id

String

七层弹性Flavor ID。

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

最小长度:1

最大长度:255

publicips

Array of PublicIpInfo objects

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

注:该字段与eips一致。

elb_virsubnet_ids

Array of strings

下联面子网的网络ID列表。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的id得到。

使用说明:

  • 若不指定该字段,则会在当前负载均衡器所在子网作为下联面子网。
  • 若指定多个下联面子网,则按顺序优先使用第一个子网来为负载均衡器下联面端口分配ip地址。
  • 下联面子网必须属于该LB所在的VPC。
  • 不支持边缘云子网。

elb_virsubnet_type

String

下联面子网类型

  • ipv4:ipv4
  • dualstack:双栈

ip_target_enable

Boolean

是否启用跨VPC后端转发。开启跨VPC后端转发后,后端服务器组支持添加其他VPC、其他公有云、云下数据中心的服务器。取值: - true:开启。 - false:不开启。 仅独享型负载均衡器支持该特性。

frozen_scene

String

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

  • POLICE:公安冻结场景。
  • ILLEGAL:违规冻结场景。
  • VERIFY:客户未实名认证冻结场景。
  • RTNER:合作伙伴冻结(合作伙伴冻结子客户资源)。
  • REAR:欠费冻结场景。

ipv6_bandwidth

BandwidthRef object

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

deletion_protection_enable

Boolean

是否开启删除保护,取值:

  • false:不开启。
  • true:开启。

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

说明:

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

autoscaling

AutoscalingRef object

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

使用说明:

  • 仅当局点支持弹性扩缩特性才会返回该字段。
  • 开启弹性扩缩容后,l4_flavor_id和l7_flavor_id不再起作用。
表10 PoolRef

参数

参数类型

描述

id

String

后端服务器组ID。

表11 ListenerRef

参数

参数类型

描述

id

String

监听器ID。

表12 Tag

参数

参数类型

描述

key

String

标签键

最小长度:1

最大长度:36

value

String

标签值

最小长度:0

最大长度:43

表13 EipInfo

参数

参数类型

描述

eip_id

String

eip_id

eip_address

String

eip_address

ip_version

Integer

IP版本号,取值:4表示IPv4,6表示IPv6。

表14 PublicIpInfo

参数

参数类型

描述

publicip_id

String

弹性公网ip配置id

publicip_address

String

IP地址

ip_version

Integer

IP版本信息。 取值:

  • 4:IPv4
  • 6:IPv6
表15 BandwidthRef

参数

参数类型

描述

id

String

共享带宽的id

表16 AutoscalingRef

参数

参数类型

描述

enable

Boolean

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

  • true:开启。
  • false:不开启。

缺省值:false

min_l4_flavor_id

String

弹性扩缩容的最小四层规格ID,有四层监听器时,该字段不能为空。

最小长度:1

最大长度:36

min_l7_flavor_id

String

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

最小长度: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
  }
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close