调用AssociateHaVip接口将高可用虚拟IPHaVip绑定到专有网络ECS实例或弹性网卡上。

使用说明

在调用本接口绑定高可用虚拟IP时,请注意:

  • HaVip绑定后立即生效,无需重启ECS实例,但需要将HaVip配置到ECS实例的弹性网卡上。
  • HaVip和要绑定的ECS实例必须同属于一个交换机。
  • 一个HaVip最多可绑定两个ECS实例。
  • 要绑定的ECS实例的状态必须为运行中停止
  • HaVip实例的状态必须为AvailableInUse
  • AssociateHaVip接口属于异步接口,即系统返回一个请求ID,但该HaVip并未绑定完成,系统后台的绑定任务仍在进行。您可以调用DescribeHaVips查询HaVip的绑定状态:
    • 当HaVip处于Associating状态时,表示HaVip正在绑定中。
    • 当HaVip处于InUse状态时,表示HaVip绑定完成。
  • AssociateHaVip接口不支持并发绑定同一个HaVip。

调试

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

请求参数

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

系统规定参数。取值:AssociateHaVip

ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe63****

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId String cn-shanghai

HaVip实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

HaVipId String havip-2zeo05qre24nhrqpy****

要绑定的HaVip实例ID。

InstanceId String i-faf344422ffsfad****

与HaVip实例绑定的ECS实例ID。

InstanceType String EcsInstance

要绑定HaVip的实例类型,取值:

  • EcsInstance:云服务器ECS实例。
  • NetworkInterface:弹性网卡实例,当绑定HaVip的实例为弹性网卡,该参数必须填写。

返回数据

名称 类型 示例值 描述
RequestId String C44F62BE-9CE7-4277-B117-69243F3988BF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=AssociateHaVip
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe63****
&RegionId=cn-shanghai
&HaVipId=havip-2zeo05qre24nhrqpy****
&InstanceId=i-faf344422ffsfad****
&InstanceType=EcsInstance
&公共请求参数

正常返回示例

XML格式

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

<AssociateHaVipResponse>
    <RequestId>C44F62BE-9CE7-4277-B117-69243F3988BF</RequestId>
</AssociateHaVipResponse>

JSON格式

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

{
  "RequestId" : "C44F62BE-9CE7-4277-B117-69243F3988BF"
}

错误码

HttpCode 错误码 错误信息 描述
400 OperationUnsupported.BindOnFreeNetworkInterface The network interface must be attached to an ECS instance. 网卡必须绑定在ECS实例上。
400 OperationUnsupported.BindMultipleType You cannot bind HaVip to multiple instance types. 不允许同时绑定ECS实例和网卡。
400 OperationUnsupported.BindOnMultipleVswitch The bound instance and HaVip must be on the same vSwitch. 绑定的实例和HaVip必须位于同一台交换机上。
400 CountLimitExceed.HaVipOnInstance The amount of HaVip associated with the specified Instance reach its limits. 超过实例的HaVip配额。
400 CountLimitExceeded.HaVipOnECSInstance The amount of Instance associated with the specified HaVip reach its limits. 超过HaVip的实例配额。
400 InvalidNetworkInterfaceId.NotFound The network interface is not found. 网卡不存在。
400 OperationFailed.QueryNetworkInterfaceInfo Failed to query network interface information. 查询网卡信息失败。
400 IllegalParam.InstanceType The specified instance type is invalid. Only ECS instances and network interface are allowed. 绑定的实例类型不允许。
400 OperationUnsupported.BindOnSameEcs You cannot bind two network interfaces on the same ECS instance. 不允许绑定同一台ECS上的两张网卡。
400 OperationUnsupported.HavipBindType You cannot bind HAVIP to network interface in the specified region. 您所在的地域不支持绑定网卡。
404 InvalidHaVipId.NotFound The specified HaVip does not exist in the specified region. 指定的HaVip不在指定的地域中,请您检查选择的地域是否正确。
404 InvalidInstanceId.NotFound The specified Instance does not exist in the specified region. 该实例在该地域内不存在。

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