调用UpdateLoadBalancerZones接口修改网络型负载均衡实例可用区及可用区属性。
注意事项
每次调用该接口时,请确保您传入该NLB实例的所有可用区参数,包括存量和新增的可用区。如您未传入存量的可用区参数,存量可用区将会被删掉。
使用说明
- 您已创建NLB实例,请参见CreateLoadBalancer。
- 您可以通过GetLoadBalancerAttribute接口查询该NLB实例的可用区及可用区属性。
- UpdateLoadBalancerZones属于异步接口,即系统返回一个请求ID,但该NLB实例可用区及可用区属性尚未修改成功,系统后台的变更任务仍在进行。您可以调用GetJobStatus查询修改状态:
- 当任务状态处于Succeeded时,表示实例可用区及可用区属性修改成功。
- 当任务状态处于Processing时,表示实例可用区及可用区属性正在修改中,在该状态下,您只能执行查询操作,不能执行其他操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateLoadBalancerZones | 系统规定参数。取值:UpdateLoadBalancerZones。 |
LoadBalancerId | String | 是 | nlb-83ckzc8d4xlp8o**** | 网络型负载均衡实例ID。 |
ZoneMappings.N.VSwitchId | String | 是 | vsw-bp1rmcrwg3erh1fh8**** | 可用区对应的交换机,每个可用区默认使用一台交换机和一个子网。 |
ZoneMappings.N.ZoneId | String | 是 | cn-hangzhou-a | 可用区ID,您可以通过调用DescribeZones接口获取。 |
ZoneMappings.N.PrivateIPv4Address | String | 否 | 192.168.36.16 | 私网IP地址。 |
ZoneMappings.N.AllocationId | String | 否 | eip-bp1aedxso6u80u0qf**** | 弹性公网IP或任播弹性公网IP的实例ID。 |
ZoneMappings.N.EipType | String | 否 | Common | 公网EIP的类型。取值:
说明 仅中国香港地域的NLB实例支持绑定Anycast EIP,且
AddressType配置为
Internet时,需要配置该参数。
|
DryRun | Boolean | 否 | false | 是否只预检此次请求,取值:
|
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-426655440000 | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。
说明 若您未指定,则系统自动使用API请求的
RequestId作为
ClientToken标识。每次API请求的
RequestId可能不一样。
|
RegionId | String | 否 | cn-hangzhou | 网络型负载均衡实例所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | CEF72CEB-54B6-4AE8-B225-F876FF7BA984 | 请求ID。 |
JobId | String | 72dcd26b-f12d-4c27-b3af-18f6aed5**** | 异步任务ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=UpdateLoadBalancerZones
&LoadBalancerId=nlb-83ckzc8d4xlp8o****
&ZoneMappings=[{"VSwitchId":"vsw-bp1rmcrwg3erh1fh8****","ZoneId":"cn-hangzhou-a","PrivateIPv4Address":"192.168.36.16","AllocationId":"eip-bp1aedxso6u80u0qf****"}]
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateLoadBalancerZonesResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
<JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</UpdateLoadBalancerZonesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}
错误码
访问错误中心查看更多错误码。