变更网络型负载均衡NLB实例的IPv4地址的网络类型。
接口说明
- 您已创建 NLB 实例,请参见 CreateLoadBalancer 。
- 您可以通过 GetLoadBalancerAttribute 接口查询变更后 NLB 实例的 AddressType 取值。
- UpdateLoadBalancerAddressTypeConfig 属于异步接口,即系统返回一个请求 ID,但该 NLB 实例 IPv4 地址的网络类型尚未变更成功,系统后台的变更任务仍在进行。您可以调用 GetJobStatus 查询 IPv4 地址网络类型变更状态:
- 当任务状态处于 Succeeded 时,表示实例 IPv4 地址的网络类型变更成功。
- 当任务状态处于 Processing 时,表示实例 IPv4 地址的网络类型变更中,在该状态下,您只能执行查询操作,不能执行其他操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
nlb:UpdateLoadBalancerAddressTypeConfig | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
LoadBalancerId | string | 是 | 网络型负载均衡实例 ID。 | nlb-83ckzc8d4xlp8o**** |
AddressType | string | 是 | 目标网络类型。取值:
| Internet |
ZoneMappings | object [] | 否 | 可用区及交换机映射列表,最多支持 10 个可用区。 | |
VSwitchId | string | 否 | 可用区对应的交换机,每个可用区只能使用一台交换机和一个子网。 | vsw-bp10ttov87felojcn**** |
ZoneId | string | 否 | 网络型负载均衡实例的可用区 ID。 您可以通过调用 DescribeZones 接口获取可用区 ID 对应的可用区信息。 | cn-hangzhou-a |
AllocationId | string | 否 | 弹性公网 IP 实例 ID。 | eip-bp1aedxso6u80u0qf**** |
EipType | string | 否 | 公网 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 | DuplicatedParam.AllocationId | The param of AllocationId is duplicated. | AllocationId参数重复,请检查参数。 |
400 | ResourceInConfiguring.loadbalancer | The specified resource of loadbalancer is being configured, please try again later. | 正在配置指定的负载均衡资源,请稍后重试。 |
400 | OperationDenied.EipAlreadyInBandwidthPackage | The operation is not allowed because of EipAlreadyInBandwidthPackage. | 由于 EIP已经加入共享带宽包的原因,操作不被允许。 |
400 | ResourceInConfiguring.%s | The specified resource of %s is being configured, please try again later. | 指定的资源%s正在配置,请稍后重试 |
400 | OperationDenied.AddressTypeNotChanged | The operation is not allowed because of AddressTypeNotChanged. | 该操作不被允许,因为地址类型未更改。 |
400 | Mismatch.ZoneIdAndVswitchId | The ZoneIdAndVswitchId is mismatched for %s and %s. | ZoneId和VswitchId缺失,请检查输入参数。 |
400 | TagInvokeError | listTagsByResourceIds: InvalidResourceId.NotFound : The specified ResourceIds are not found in our records. | 在资源标签中找不到资源定义,请检查RAM是否给NLB添加授权。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | dryRun请求验证已通过。 |
400 | IllegalParam | The param of %s is illegal. | 输入的参数有值非法,请检查输入。 |
403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因为账号没有权限,所以鉴权失败。 |
404 | ResourceNotFound.loadBalancer | The specified resource of loadbalancer is not found. | 找不到指定的负载均衡器资源,请检查输入参数。 |
404 | ResourceNotFound.AnycastInstance | The specified resource of AnycastInstance is not found. | 找不到指定的 Anycast 实例资源。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-02-04 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2024-01-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-10-30 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-09-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-09-05 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|