文档

UpdateLoadBalancerAddressTypeConfig - 变更负载均衡实例的网络类型配置

更新时间:

变更应用型负载均衡实例的网络类型。

接口说明

前提条件:

  • 您已经创建应用型负载均衡实例,具体操作,请参见 CreateLoadBalancer
  • 当您需要通过此接口将应用型负载均衡实例的网络类型由私网变为公网时,您需要先创建一个弹性公网 IP。具体操作,请参见 AllocateEipAddress

使用说明:

UpdateLoadBalancerAddressTypeConfig 接口属于异步接口,即系统返回一个请求 ID,但该应用型负载均衡实例的网络类型尚未变更成功,系统后台的变更任务仍在进行。您可以调用 GetLoadBalancerAttribute 查询应用型负载均衡实例的网络类型的变更状态:

  • 当应用型负载均衡实例处于 Configuring 状态时,表示应用型负载均衡实例的网络类型正在变更中。
  • 当应用型负载均衡实例处于 Active 状态时,表示应用型负载均衡实例的网络类型变更成功。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alb:UpdateLoadBalancerAddressTypeConfigupdate
  • LoadBalancer
    acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
  • alb:AddressType

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-42665544****
DryRunstring

是否只预检此次请求。取值:

  • true:发送检查请求,不会更新实例的网络类型。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
LoadBalancerIdstring

应用型负载均衡实例 ID。

alb-bp1o94dp5i6ea****
AddressTypestring

目标网络类型。取值:

  • Internet:负载均衡具有公网 IP 地址,DNS 域名被解析到公网 IP,因此可以在公网环境访问。

  • Intranet:负载均衡只有私网 IP 地址,DNS 域名被解析到私网 IP,因此只能被负载均衡所在 VPC 的内网环境访问。

Internet
ZoneMappingsarray<object>

可用区及交换机映射列表,最多支持添加 10 个可用区。若当前地域支持 2 个及以上的可用区,至少需要添加 2 个可用区。

object

可用区及交换映射列表结构体。

VSwitchIdstring

可用区对应的交换机,每个可用区只能使用一台交换机和一个子网。最多支持添加 10 个可用区。若当前地域支持 2 个及以上的可用区,至少需要添加 2 个可用区。

vsw-bp10ttov87felojcn****
ZoneIdstring

应用型负载均衡实例的可用区 ID。最多支持添加 10 个可用区。若当前地域支持 2 个及以上的可用区,至少需要添加 2 个可用区。

您可以通过调用 DescribeZones 接口获取可用区 ID 对应的可用区信息。

cn-hangzhou-a
AllocationIdstring

弹性公网 IP 实例 ID。最多支持添加 10 个可用区。

说明 调用此接口由私网转换为公网时,需要输入此参数。
eip-bp1aedxso6u80u0qf****
EipTypestring

弹性公网 IP 的类型。取值:

  • Common(默认值):弹性公网 IP。

  • Anycast:任播弹性公网 IP。

说明 ALB 支持绑定 Anycast EIP 的地域,请参见使用限制
Common

返回参数

名称类型描述示例值
object

返回数据结构体。

RequestIdstring

请求 ID。

593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
JobIdstring

异步任务 ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****

示例

正常返回示例

JSON格式

{
  "RequestId": "593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

HTTP status code错误码错误信息描述
400OperationDenied.OnlyPostPaidEipSupportedThe operation is not allowed because of OnlyPostPaidEipSupported.操作被拒绝,原因是只支持后付费类型的弹性公网IP。
400Mismatch.ZoneIdAndVSwitchIdThe ZoneId and VSwitchId are mismatched.可用区ID和交换机ID不匹配。
400IncorrectBusinessStatus.EipThe business status of %s [%s]  is incorrect.资源%s [%s]的业务状态无效。
400ResourceNotFound.EipThe specified resource ResourceNotFound.Eip is not found.资源弹性公网IP不存在。
400IncorrectStatus.CommonBandwidthPackageThe status of %s [%s] is incorrect.资源%s [%s]的状态无效。
400IncorrectBusinessStatus.CommonBandwidthPackageThe business status of %s [%s] is incorrect.资源%s [%s]的业务状态无效。
400OperationDenied.AddressTypeNotChangedThe operation is not allowed because of AddressTypeNotChanged.该负载均衡实例的网络类型未变更
400IncorrectStatus.LoadBalancerThe status of %s [%s] is incorrect.资源%s [%s]的状态无效。
404ResourceNotFound.CommonBandwidthPackageThe specified resource %s is not found.资源%s不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-23OpenAPI 错误码发生变更查看变更详情
2024-01-29OpenAPI 错误码发生变更查看变更详情
2024-01-29OpenAPI 错误码发生变更查看变更详情
2021-10-27新增 OpenAPI查看变更详情