文档

AssociateHaVip - 将HaVip绑定到专有网络ECS实例上

更新时间:

调用AssociateHaVip接口将HaVip绑定到专有网络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代码示例。

授权信息

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

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

请求参数

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

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
0c593ea1-3bea-11e9-b96b-88e9fe63****
RegionIdstring

HaVip 实例所在的地域 ID。

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

cn-shanghai
HaVipIdstring

要绑定的 HaVip 实例 ID。

havip-2zeo05qre24nhrqpy****
InstanceIdstring

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

i-faf344422ffsfad****
InstanceTypestring

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

  • EcsInstance:云服务器 ECS 实例。

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

EcsInstance

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

C44F62BE-9CE7-4277-B117-69243F3988BF

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400OperationUnsupported.BindOnFreeNetworkInterfaceThe network interface must be attached to an ECS instance.网卡必须绑定在ECS实例上。
400OperationUnsupported.BindMultipleTypeYou cannot bind HaVip to multiple instance types.不允许同时绑定ECS实例和网卡。
400OperationUnsupported.BindOnMultipleVswitchThe bound instance and HaVip must be on the same vSwitch.绑定的实例和HaVip必须位于同一台交换机上。
400InvalidVip.Statusvip invalid status-
400IncorrectHaVipStatusHaVip can be operated by this action only when it's status is Available or InUse.Havip实例为Available或InUse才允许操作
400IncorrectInstanceStatusECS instance can be operated by this action only when it?s status is Running or Stopped.-
400CountLimitExceed.HaVipOnInstanceThe amount of HaVip associated with the specified Instance reach its limits.超过实例的HaVip配额。
400CountLimitExceeded.HaVipOnECSInstanceThe amount of Instance associated with the specified HaVip reach its limits.超过HaVip的实例配额。
400OperationFailed.DistibuteLockDistibute lock fail.操作被其他请求加锁;
400InvalidNetworkInterfaceId.NotFoundThe network interface is not found.网卡不存在。
400OperationFailed.QueryNetworkInterfaceInfoFailed to query network interface information.查询网卡信息失败。
400IllegalParam.InstanceTypeThe specified instance type is invalid. Only ECS instances and network interface are allowed.绑定的实例类型不允许。
400OperationUnsupported.BindOnSameEcsYou cannot bind two network interfaces on the same ECS instance.不允许绑定同一台ECS上的两张网卡。
400OperationUnsupported.HavipBindTypeYou cannot bind HAVIP to network interface in the specified region.您所在的地域不支持绑定网卡。
400InvalidInstance.NotExistInvalidInstance.NotExist : The specified Instance does not exist in the specified region. i-bp136w25mhx503ptilrh\r\nRequestId : A961CC27-D797-4E16-B1B3-19B9ECBA1495-
400OperationDenied.BindOnSameEcsThe operation is not allowed because networkinterface bind on same instance.-
400Forbidden.HaVipNo permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.操作HaVip没有权限,请到配额中心申请权限。
400InvalidInstanceId.NotFoundThe specified Instance does not exist in the specified region.该实例在该地域内不存在。
400ResourceNotFound.EcsInstanceThe specified resource of ECS instance is not found.指定的ECS实例不存在。
400InvalidStatus.NotAllowBind instance status invalid绑定实例状态无效
404InvalidHaVip.ExisthaVip already bind exist.-
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。
404InvalidHaVipId.NotFoundThe specified HaVip does not exist in the specified region.指定的HaVip不在指定的地域中,请您检查选择的地域是否正确。
404QuotaExceeded.HaVipBindInstanceThe amount of instance associated with the specified haVip reach its limits.-

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

变更历史

变更时间变更内容概要操作
2023-11-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
2023-09-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
2023-08-03OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2023-07-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
  • 本页导读 (1)