# 新增负载均衡器可用区 - BatchAddAvailableZones #### 功能介绍 给负载均衡器新增可用区。 #### 接口约束 仅限独享型负载均衡器使用。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-elb/elb_dy_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-elb/elb_sq_0001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | elb:loadbalancers:update | Write | subnet | - | elb:loadbalancers:put | - | | elb:loadbalancers:update | Write | loadbalancer \* | - g:ResourceTag/\ - g:EnterpriseProjectId | elb:loadbalancers:put | - | | elb:loadbalancers:update | Write | - | elb:AssociatePublicips | elb:loadbalancers:put | - | #### URI POST /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/availability-zone/batch-add 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 | | loadbalancer_id | 是 | String | **参数解释**：负载均衡器ID。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释**：IAM鉴权Token。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | availability_zone_list | 是 | Array of strings | **参数解释**：新增的可用区列表。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | loadbalancer | [LoadBalancer] object | **参数解释**：负载均衡器的详细信息。 | | request_id | String | **参数解释**：请求ID。 **取值范围**：由数字、小写字母和中划线（-）组成的字符串，自动生成。 | | loadbalancer_id | String | **参数解释**：负载均衡器的ID。（包周期场景返回该字段） **取值范围**：不涉及 | | order_id | String | **参数解释**：订单号。（包周期规格变更场景返回该字段） **取值范围**：不涉及 | 表5LoadBalancer | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：负载均衡器ID。 **取值范围**：不涉及 | | description | String | **参数解释**：负载均衡器描述信息。 **取值范围**：不涉及 | | provisioning_status | String | **参数解释**：负载均衡器的配置状态。 **取值范围**： - ACTIVE：使用中。 - PENDING_DELETE：删除中。 | | admin_state_up | Boolean | **参数解释**：负载均衡器的启用状态。 **取值范围**： - true ：启用。 - false：停用。 | | provider | String | **参数解释**：负载均衡器的生产者名称。固定为vlb。 **取值范围**：不涉及 | | pools | Array of [PoolRef] objects | **参数解释**：负载均衡器直接关联的后端服务器组的ID列表。 | | listeners | Array of [ListenerRef] objects | **参数解释**：负载均衡器关联的监听器的ID列表。 | | operating_status | String | **参数解释**：负载均衡器的操作状态。 **取值范围**： - ONLINE：在线。 - FROZEN：已冻结。 | | 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。 说明： 该字段与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企业项目。 - UUID格式的字符串，表示非默认企业项目。 | | billing_info | String | **参数解释**：资源账单信息。 **取值范围**： - 空：按需计费。 - 非空：包周期计费，格式为：order_id:product_id:region_id:project_id。如：CS2107161019CDJZZ:OFFI569702121789763584:az1:057ef081eb00d2732fd1c01a9be75e6f | | l4_flavor_id | String | **参数解释**：负载均衡器4层规格ID。 若当前负载均衡器是弹性规格实例，则该字段表示4层上限规格。 **取值范围**：不涉及 | | l4_scale_flavor_id | String | **参数解释**：四层弹性规格ID。 **取值范围**：不涉及 说明： 该字段已经废弃，请勿使用。 | | l7_flavor_id | String | **参数解释**：负载均衡器7层规格ID。 若当前负载均衡器是弹性规格实例，则该字段表示7层上限规格。 **取值范围**：不涉及 | | l7_scale_flavor_id | String | **参数解释**：七层弹性Flavor ID。 **取值范围**：不涉及 说明： 该字段已经废弃，请勿使用。 | | gw_flavor_id | String | **参数解释**：网关型负载均衡器的规格ID。 **取值范围**：不涉及 不支持该字段，请勿使用。 | | loadbalancer_type | String | **参数解释**：负载均衡器类别。 **取值范围**： - gateway 表示网关类型负载均衡器。 - null 表示其他非网关类型负载均衡器。 不支持该字段，请勿使用。 | | publicips | Array of [PublicIpInfo] objects | **参数解释**：负载均衡器绑定的公网IP。 说明： 该字段与eips一致。 | | global_eips | Array of [GlobalEipInfo] objects | **参数解释**：负载均衡器绑定的global eip。 | | elb_virsubnet_ids | Array of strings | **参数解释**：下联面子网的网络ID列表。 **取值范围**：不涉及 | | elb_virsubnet_type | String | **参数解释**：下联面子网类型。 **取值范围**： - ipv4：仅支持IPv4 - dualstack：双栈，同时支持IPv4和IPv6。 | | ip_target_enable | Boolean | **参数解释**：是否启用IP类型后端转发。 开启IP类型后端转发后，后端服务器组不仅支持添加云上VPC内的服务器，还支持添加其他VPC、其他公有云、云下数据中心的服务器。 **取值范围**： - true：开启。 - false：不开启。 | | frozen_scene | String | **参数解释**：负载均衡器的冻结场景。 若负载均衡器有多个冻结场景，用逗号分隔。 **取值范围**： - POLICE：公安冻结场景。 - ILLEGAL：违规冻结场景。 - VERIFY：客户未实名认证冻结场景。 - PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。 - ARREAR：欠费冻结场景。 | | deletion_protection_enable | Boolean | **参数解释**：是否开启删除保护。仅当前局点启用删除保护特性后才会返回该字段。 **取值范围**： - false：不开启。 - true：开启。 | | autoscaling | [AutoscalingRef] object | **参数解释**：弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。 说明： 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 | | public_border_group | String | **参数解释**：公网边界组。 **取值范围**： - center：表示中心站点的公网边界组 - 边缘站点名称：表示边缘站点的公网边界组 | | charge_mode | String | **参数解释**：负载均衡器实例的计费模式。 **取值范围**： - flavor：按规格计费。 - lcu：按使用量计费。 - 空值：若是共享型表示免费实例。若是独享型则与flavor模式一致，都是按规格计费。 | | service_lb_mode | String | **参数解释**：LB模式。 **取值范围**： - lb：默认模式，不支持跨租户访问。 - ep：ep模式，LB支持跨租户访问。 不支持该字段，请勿使用。 | | instance_type | String | **参数解释**：标识实例归属哪个内部服务。 **取值范围**：不涉及 不支持该字段，请勿使用。 | | instance_id | String | **参数解释**：标识实例绑定内部服务的实例ID。 **取值范围**：不涉及 不支持该字段，请勿使用。 | | proxy_protocol_extensions | Array of [ProxyProtocolExtension] objects | **参数解释**：pp扩展。 不支持该字段，请勿使用。 | | waf_failure_action | String | **参数解释**：WAF故障时的流量处理策略。 **取值范围**：discard:丢弃，forward: 转发到后端。 | | protection_status | String | **参数解释**：修改保护状态。 **取值范围**： - nonProtection：不保护。 - consoleProtection：控制台修改保护。 | | protection_reason | String | **参数解释**：设置保护的原因。作为protection_status的转态设置的原因。 **取值范围**：除'\<'和'\>'外通用Unicode字符集字符，最大255个字符。 | | log_group_id | String | **参数解释**：LB所关联的云日志服务（LTS）的日志组ID。 **取值范围**：不涉及 | | log_topic_id | String | **参数解释**：LB所关联的云日志服务（LTS）的日志组下的日志流ID。 **取值范围**：不涉及 | | custom_qos_limit | [CustomQosLimit] object | **参数解释**：弹性负载均衡器的规格的自定义限速信息。 不支持该字段，请勿使用。 | 表6PoolRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：后端服务器组ID。 **取值范围**：不涉及 | 表7ListenerRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：监听器ID。 **取值范围**：不涉及 | 表8Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：标签键。 **取值范围**：不涉及 | | value | String | **参数解释**：标签值。 **取值范围**：不涉及 | 表9EipInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | eip_id | String | **参数解释**：弹性IP的ID。 **取值范围**：不涉及 | | eip_address | String | **参数解释**：弹性IP的IP地址。 **取值范围**：不涉及 | | ip_version | Integer | **参数解释**：IP版本号。 **取值范围**： - 4：表示IPv4地址。 - 6：表示IPv6地址。 | 表10PublicIpInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publicip_id | String | **参数解释**：弹性公网EIP的ID。 **取值范围**：不涉及 | | publicip_address | String | **参数解释**：EIP的IP地址。 **取值范围**：不涉及 | | ip_version | Integer | **参数解释**：IP版本信息。 **取值范围**： - 4：IPv4地址。 - 6：IPv6地址。 | 表11GlobalEipInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | global_eip_id | String | **参数解释**：global eip的ID。 **取值范围**：不涉及 | | global_eip_address | String | **参数解释**：global eip的ip地址。 **取值范围**：不涉及 | | ip_version | Integer | **参数解释**：IP版本信息。 **取值范围**： - 4，表示IPv4 - 6，表示IPv6 | 表12AutoscalingRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | enable | Boolean | **参数解释**：当前负载均衡器是否开启弹性扩缩容。 **取值范围**： - true：开启。 - false：不开启。 | | min_l7_flavor_id | String | **参数解释**：弹性扩缩容的最小七层规格ID（规格类型L7_elastic）。 **取值范围**：不涉及 | 表13ProxyProtocolExtension | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vip_address | String | **参数解释**：ipv4 vip地址。 **取值范围**：不涉及 | | ipv6_vip_address | String | **参数解释**：ipv6 vip地址。 **取值范围**：不涉及 | | extension | [Extension] object | **参数解释**：pp 扩展。 | 表14Extension | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ep_id | String | **参数解释**：EP ID. **取值范围**：不涉及 | | ep_service_id | String | **参数解释**：EP Service ID. **取值范围**：不涉及 | 表15CustomQosLimit | 参数 | 参数类型 | 描述 | |:---|:---|:---| | l4 | [L4Limit] object | **参数解释**：负载均衡实例的四层规格自定义限速信息。 | | l7 | [L7Limit] object | **参数解释**：负载均衡实例的七层规格自定义限速信息。 | 表16L4Limit | 参数 | 参数类型 | 描述 | |:---|:---|:---| | connection | Integer | **参数解释**：负载均衡实例的四层规格的最大并发连接数限速值。 **取值范围**：不涉及 | | cps | Integer | **参数解释**：负载均衡实例的四层规格的每秒新建连接数限速值。 **取值范围**：不涉及 | 表17L7Limit | 参数 | 参数类型 | 描述 | |:---|:---|:---| | connection | Integer | **参数解释**：负载均衡实例的七层规格的最大并发连接数限速值。 **取值范围**：不涉及 | | cps | Integer | **参数解释**：负载均衡实例的七层规格的每秒新建连接数限速值。 **取值范围**：不涉及 | #### 请求示例 给负载均衡器新增可用区 ``` POST https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/9b663cd9-61e4-483d-b91f-92fc337fecec/availability-zone/batch-add { "availability_zone_list" : [ "az2", "az3" ] } ``` #### 响应示例 **状态码：200** 操作正常返回。 ``` { "request_id" : "6c63d0ac-7beb-451d-a3e0-a066beaea316", "loadbalancer" : { "id" : "9b663cd9-61e4-483d-b91f-92fc337fecec", "project_id" : "060576782980d5762f9ec014dd2f1148", "name" : "elb-reset", "description" : "", "vip_port_id" : null, "vip_address" : null, "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ ], "pools" : [ ], "tags" : [ ], "provider" : "vlb", "created_at" : "2021-07-26T02:46:31Z", "updated_at" : "2021-07-26T02:46:59Z", "vpc_id" : "59cb11ef-f185-49ba-92af-0539e8ff9734", "enterprise_project_id" : "0", "availability_zone_list" : [ "az1", "az2", "az3" ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ { "publicip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "publicip_address" : "97.97.2.171", "ip_version" : 4 } ], "elb_virsubnet_ids" : [ "7f817f9c-8731-4002-9e47-18cb8d431787" ], "elb_virsubnet_type" : "dualstack", "ip_target_enable" : false, "autoscaling" : { "enable" : false, "min_l7_flavor_id" : "" }, "frozen_scene" : null, "eips" : [ { "eip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "eip_address" : "97.97.2.171", "ip_version" : 4 } ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "636ba721-935a-4ca5-a685-8076ce0e4148", "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : null, "public_border_group" : "center", "protection_status" : "nonProtection", "protection_reason" : "" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 给负载均衡器新增可用区 ``` 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.*; import java.util.List; import java.util.ArrayList; public class BatchAddAvailableZonesSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("")) .build(); BatchAddAvailableZonesRequest request = new BatchAddAvailableZonesRequest(); request.withLoadbalancerId("{loadbalancer_id}"); BatchAddAvailableZonesRequestBody body = new BatchAddAvailableZonesRequestBody(); List listbodyAvailabilityZoneList = new ArrayList<>(); listbodyAvailabilityZoneList.add("az2"); listbodyAvailabilityZoneList.add("az3"); body.withAvailabilityZoneList(listbodyAvailabilityZoneList); request.withBody(body); try { BatchAddAvailableZonesResponse response = client.batchAddAvailableZones(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()); } } } ``` - [Python] 给负载均衡器新增可用区 ``` # coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("")) \ .build() try: request = BatchAddAvailableZonesRequest() request.loadbalancer_id = "{loadbalancer_id}" listAvailabilityZoneListbody = [ "az2", "az3" ] request.body = BatchAddAvailableZonesRequestBody( availability_zone_list=listAvailabilityZoneListbody ) response = client.batch_add_available_zones(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 给负载均衡器新增可用区 ``` 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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := elb.ElbClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := elb.NewElbClient(hcClient) request := &model.BatchAddAvailableZonesRequest{} request.LoadbalancerId = "{loadbalancer_id}" var listAvailabilityZoneListbody = []string{ "az2", "az3", } request.Body = &model.BatchAddAvailableZonesRequestBody{ AvailabilityZoneList: listAvailabilityZoneListbody, } response, err := client.BatchAddAvailableZones(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ELB/sdk?api=BatchAddAvailableZones&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作正常返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-elb/ErrorCode.html)。