调用AssociateEipAddress接口将弹性公网IP(Elastic IP Address,简称EIP)绑定到同地域的云产品实例上。
使用说明
- EIP实例可绑定到同地域的专有网络类型的ECS实例、专有网络类型的CLB实例、辅助弹性网卡、NAT网关和高可用虚拟IP上。
- AssociateEipAddress接口属于异步接口,即系统会先返回一个请求ID,但EIP实例与云产品实例并未绑定完成,系统后台的绑定任务仍在进行。您可以调用DescribeEipAddresses查询EIP实例的状态:
- 当EIP实例处于Associating状态时,表示EIP实例正在绑定中,在该状态下,您只能执行查询操作,不能执行其他操作。
- 当EIP实例处于InUse状态时,表示EIP实例绑定完成。
- AssociateEipAddress接口不支持同一个EIP实例并发绑定云产品实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | AssociateEipAddress | 系统规定参数。取值:AssociateEipAddress。 |
RegionId | String | 是 | cn-hangzhou | 要绑定云产品实例的EIP所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
AllocationId | String | 是 | eip-2zeerraiwb7ujsxdc**** | 绑定云产品实例的EIP的ID。 |
InstanceId | String | 是 | i-2zebb08phyczzawe**** | 要绑定EIP的实例ID。 支持输入NAT网关实例ID、传统型负载均衡CLB实例ID、云服务器ECS实例ID、辅助弹性网卡实例ID、高可用虚拟IP实例ID、IP地址。 |
InstanceType | String | 否 | EcsInstance | 要绑定EIP的实例的类型,取值:
说明 默认要绑定EIP的实例类型为EcsInstance,如果您需要绑定EIP的实例类型不为EcsInstance,则该值必填。 |
InstanceRegionId | String | 否 | cn-hangzhou | 要绑定EIP的实例所属地域的ID。 说明 仅在EIP加入到带宽共享型全球加速实例后,才需要填写该参数。 |
PrivateIpAddress | String | 否 | 192.168.XX.XX | 交换机网段内的一个IP地址。 如果不输入该参数,系统根据VPC ID和交换机ID自动分配一个私网IP地址。 |
Mode | String | 否 | NAT | 绑定模式,取值:
说明 仅InstanceType配置为NetworkInterface时,才需要配置该参数。 |
VpcId | String | 否 | vpc-257gqcdfvx6n**** | 开通了IPv4网关功能且与EIP同地域的VPC ID。 EIP绑定IP地址时,系统可以根据该VPC的路由配置,使绑定的IP地址具备公网访问能力。 说明 InstanceType取值为IpAddress时,即要绑定EIP的实例类型为IP地址时,该参数必填。 |
ClientToken | String | 否 | 0c593ea1-3bea-11e9-b96b-88e9fe63**** | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 0ED8D006-F706-4D23-88ED-E11ED28DCAC0 | 请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=AssociateEipAddress
&RegionId=cn-hangzhou
&AllocationId=eip-2zeerraiwb7ujsxdc****
&InstanceId=i-2zebb08phyczzawe****
&InstanceType=EcsInstance
&InstanceRegionId=cn-hangzhou
&PrivateIpAddress=192.168.XX.XX
&Mode=NAT
&VpcId=vpc-257gqcdfvx6n****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe63****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AssociateEipAddressResponse>
<RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</AssociateEipAddressResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidAssociation.Duplicated | Specified instance already is associated. | 该实例已绑定EIP或全球加速实例,不能再绑定,如需更换实例绑定的EIP或全球加速实例,请先解绑。 |
400 | OperationDenied | Specified instance is not in VPC. | 该实例在VPC中不存在。 |
400 | InvalidParameter.Mismatch | Specified elastic IP address and ECS instance are not in the same region. | 该EIP和ECS实例不在同一个地域内。 |
400 | IncorrectEipStatus | Current elastic IP status does not support this operation | 当前EIP的状态不支持该操作。 |
400 | IncorrectInstanceStatus | Current instance status does not support this operation. | 当前实例的状态不支持该操作。 |
400 | InvalidInstanceType.ValueNotSupported | The specified value of InstanceType is not supported. | 参数InstanceType的值不合法。 |
400 | InvalidParameter | The specified parameter is not valid. | 该参数值不合法。 |
400 | OperationDenied | Eip of default vpc not allow this operation | 默认专有网络的EIP不支持该操作。 |
400 | TaskConflict | The eip operate too frequent, TaskConflict. | 操作过于频繁,任务冲突。 |
400 | InvalidBindingStatus | The eip binding status invalid. | EIP绑定状态不正确。 |
400 | BIND_INSTANCE_HAVE_PORTMAP_OR_BIND_EIP | The instance may have portMap or already bind eip. | ECS 实例已经存在端口转发规则,请删除相应的端口转发规则再进行操作。 |
400 | BIND_INSTANCE_OWENER_ERROR | Cannot operate the eip. | 不能操作这个EIP。 |
400 | QuotaExceeded.NumberOfEip | Binded eip Quota exceed on this NatGw. | 此NAT网关上,绑定的EIP数量已经超出配额限制 |
400 | InvalidAction.Denied | Action is denied due to unfinished Eip configuration modification. | 由于未完成Eip配置修改,操作被拒绝。 |
400 | InvalidParams.NotFound | instance not found | 实例不存在。 |
400 | Eni.Attached | The eni should be detached from ecs when associating with direct eip. | 当ENI绑定直通EIP时,需要ENI与ECS解绑 |
400 | InvalidNexthop.DirectEni | The direct Eni cannot be nexthop. | 直通Eni不能作为下一跳 |
400 | InvalidEIPStatus.BizDisabled | The EIP has been locked. | EIP实例被锁定 |
400 | InvalidStatus.NotAllow | Bind instance status invalid | 绑定实例状态无效 |
400 | OperationDenied.CloudBoxResourceExist | The operation is not allowed because there are resources related to the cloud box in VPC. | 指定操作被禁止,因为VPC中存在云盒相关的资源。 |
400 | OperationDenied.CloudBoxVSwitchExist | The operation is not allowed because a cloud box type vSwitch exists in VPC. | 指定操作被禁止,因为VPC中存在云盒类型的虚拟交换机。 |
400 | OperationDenied.NoAvailablePrivateIp | The operation is failed because of VSwitch has not availalbe private ip | 当前虚拟交换机下的可用私网IP不足 |
400 | OperationFailed.Ipv4GatewayNotOpenedInVpc | The operation is failed because Ipv4Gateway is not opened in Vpc. | EIP绑定IP失败,因为该VPC未开启IPv4网关. |
400 | Forbidden | The eip instance owner error | EIP 不属于当前调用者,请您检查该 EIP 是否可被您调用。 |
400 | Forbidden.FinancialLocked | The ip business status is invalid. | 该实例已欠费锁定,无法操作 |
400 | UnsupportedFeature.EipBindIpAddress | The feature of EipBindIpAddress is not supported. | Eip绑定IpAddress特性不支持。 |
400 | OperationFailed.InstanceNotExist | The ECS instance does not exist, or is not a VPC VM. | ECS绑定EIP失败,因为ECS实例不存在或不是VPC虚拟机. |
400 | OperationDenied.Ipv4GatewayExist | The operation is not allowed because of Ipv4GatewayExist. | EIP绑定操作失败,因为此VPC下存在Ipv4网关 |
400 | OperationFailed.EipBindModeConflict | Eips can not bind Eni with NAT mode and MULTI_BINDED mode at the same time. | Eip不能同时以NAT模式和多EIP网卡可见模式绑定ENI. |
400 | OperationFailed.EcsMigrating | The operation is failed because of ECS is migrating. | 绑定操作失败,因为ECS正在迁移。 |
404 | InvalidInstanId.NotFound | Specified instance does not exist. | 指定的实例不存在,请您检查该实例是否正确。 |
404 | InvalidAllocationId.NotFound | Specified allocation ID is not found | 指定的公网IP不存在,请您检查您填写的参数是否正确。 |
404 | Forbidden.RegionNotFound | Specified instance is not found during access authentication. | 当前Region不支持 |
404 | OperationDenied.VpcIpv4GatewayEnabled | The operation is not allowed because of the VPC of the NAT gateway has opened IPv4 Gateway. | 不允许操作,因为NAT网关的VPC已经开启IPv4网关 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 请求失败,因为临时服务器故障。 |
访问错误中心查看更多错误码。