调用UpdateLoadBalancerAddressTypeConfig接口变更网络型负载均衡NLB实例的IPv4地址的网络类型。

使用说明

  • 您已创建NLB实例,请参见CreateLoadBalancer
  • 您可以通过GetLoadBalancerAttribute接口查询变更后NLB实例的AddressType取值。
  • UpdateLoadBalancerAddressTypeConfig属于异步接口,即系统返回一个请求ID,但该NLB实例IPv4地址的网络类型尚未变更成功,系统后台的变更任务仍在进行。您可以调用GetJobStatus查询IPv4地址网络类型变更状态:
    • 当任务状态处于Succeeded时,表示实例IPv4地址的网络类型变更成功。
    • 当任务状态处于Processing时,表示实例IPv4地址的网络类型变更中,在该状态下,您只能执行查询操作,不能执行其他操作。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateLoadBalancerAddressTypeConfig

系统规定参数。取值:UpdateLoadBalancerAddressTypeConfig

LoadBalancerId String nlb-83ckzc8d4xlp8o****

网络型负载均衡实例ID。

AddressType String Internet

目标网络类型。取值:

  • Internet:负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。
  • Intranet:负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。
ZoneMappings.N.VSwitchId String vsw-bp10ttov87felojcn****

可用区对应的交换机,每个可用区只能使用一台交换机和一个子网。

ZoneMappings.N.ZoneId String cn-hangzhou-a

网络型负载均衡实例的可用区ID。

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

ZoneMappings.N.AllocationId String eip-bp1aedxso6u80u0qf****

弹性公网IP实例ID。

ZoneMappings.N.EipType String Common

公网EIP的类型。取值:

  • Common:弹性公网IP,简称EIP。
  • Anycast:任播弹性公网IP,简称Anycast EIP。
说明 仅中国香港地域的NLB实例支持绑定Anycast EIP,且AddressType配置为Internet时,需要配置该参数。
DryRun Boolean false

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

  • true:发送检查请求,不会更新实例的网络类型。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
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=UpdateLoadBalancerAddressTypeConfig
&LoadBalancerId=nlb-83ckzc8d4xlp8o****
&AddressType=Internet
&ZoneMappings=[{"VSwitchId":"vsw-bp10ttov87felojcn****","ZoneId":"cn-hangzhou-a","AllocationId":"eip-bp1aedxso6u80u0qf****","EipType":"Common"}]
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateLoadBalancerAddressTypeConfigResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</UpdateLoadBalancerAddressTypeConfigResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

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