修改网络型负载均衡实例可用区及可用区属性。
接口说明
每次调用该接口时,请确保您传入该 NLB 实例的所有可用区参数,包括存量和新增的可用区。如您未传入存量的可用区参数,存量可用区将会被删掉。
前提条件:
- 您已创建 NLB 实例,请参见 CreateLoadBalancer 。
- 您可以通过 GetLoadBalancerAttribute 接口查询该 NLB 实例的可用区及可用区属性。
- UpdateLoadBalancerZones 属于异步接口,即系统返回一个请求 ID,但该 NLB 实例可用区及可用区属性尚未修改成功,系统后台的变更任务仍在进行。您可以调用 GetJobStatus 查询修改状态:
- 当任务状态处于 Succeeded 时,表示实例可用区及可用区属性修改成功。
- 当任务状态处于 Processing 时,表示实例可用区及可用区属性正在修改中,在该状态下,您只能执行查询操作,不能执行其他操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
nlb:UpdateLoadBalancerZones | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
LoadBalancerId | string | 是 | 网络型负载均衡实例 ID。 | nlb-83ckzc8d4xlp8o**** |
ZoneMappings | object [] | 是 | 可用区及交换机映射列表,最多支持添加 10 个可用区。 | |
VSwitchId | string | 是 | 可用区对应的交换机,每个可用区默认使用一台交换机和一个子网。 | vsw-bp1rmcrwg3erh1fh8**** |
ZoneId | string | 是 | 可用区 ID,您可以通过调用 DescribeZones 接口获取。 | cn-hangzhou-a |
PrivateIPv4Address | string | 否 | 私网 IP 地址。 | 192.168.36.16 |
AllocationId | string | 否 | 弹性公网 IP 或任播弹性公网 IP 的实例 ID。 | eip-bp1aedxso6u80u0qf**** |
EipType | string | 否 | 公网 EIP 的类型。取值:
说明
支持绑定 Anycast EIP 的地域见使用限制
,AddressType 配置为 Internet 时,需要配置该参数。
| Common |
DryRun | boolean | 否 | 是否只预检此次请求,取值:
| false |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
RegionId | string | 否 | 网络型负载均衡实例所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ResourceInCreating.loadbalancer | The specified resource of loadbalancer is creating, please try again later. | 正在创建指定的负载均衡器资源,请稍后重试。 |
400 | OperationDenied.ProtectedPrivateIPv4AddressChanged | The operation is not allowed because of ProtectedPrivateIPv4AddressChanged. | 由于受保护的私有 IPv4 地址已更改的原因,操作不被允许。 |
400 | OperationFailed.vSwitchNotSupportIpv6 | The operation failed because of vSwitchNotSupportIpv6. | 所使用的虚拟交换机(vSwicth)不支持ipv6协议,请确认输入参数。 |
400 | OperationDenied.%s | The operation is not allowed because of %s. | 因为%s,当前操作是不允许的 |
400 | OperationDenied.ZoneVSwitchChanged | The operation is not allowed because of ZoneVSwitchChanged. | 已存在的可用区不允许虚拟交换机发生变化。 |
400 | InvalidZones | The current zone list is illegal. | Zone maping中使用的可用区非法。 |
400 | ResourceInConfiguring.loadbalancer | The specified resource of loadbalancer is being configured, please try again later. | 正在配置指定的负载均衡资源,请稍后重试。 |
400 | SystemBusy | System is busy, please try again later. | 系统繁忙,请稍后重试 |
400 | ResourceNotEnough.VSwitchIp | The specified resource of VSwitchIp is not enough. | 所指定的虚拟交换机(VSwitch) IP资源不足。 |
403 | UnauthorizedZone | The specified zone of %s is not authorized. | 指定的可用区%s未被授权使用 |
404 | ResourceNotFound.loadBalancer | The specified resource of loadbalancer is not found. | 找不到指定的负载均衡器资源,请检查输入参数。 |
404 | ResourceNotFound.VSwitch | The specified resource of vSwitch is not found. | 找不到指定的虚拟交换机资源,请检查输入参数。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-04-02 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2024-01-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-12-18 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-10-30 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-09-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-09-05 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|