AssociateEipAddress

1. 接口描述

调用本接口将EIP绑定到同区域的机器实例上。

注意事项

  • 只有状态为 AVAILABLE 的EIP才能操作。

  • Esxi操作系统的机器实例无法绑定EIP。

  • EIP与机器实例的可用区需一致。

  • 机器实例的状态需要是RUNNING。

  • 一个机器实例绑定的EIP数量有限额,如需提高限额,请联系support。

  • 本接口属于异步接口,即系统会先返回一个请求ID,但EIP与机器实例并未绑定完成,系统后台的绑定任务仍在进行。您可以调用DescribeEipAddresses查询EIP的状态:

    • 当EIP处于 ASSOCIATING 状态时,表示EIP正在绑定中,在该状态下,您只能执行查询操作,不能执行其他操作。

    • 当EIP处于 ASSOCIATED 状态时,表示EIP绑定完成。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

eipId

String

一个EIP ID。

可通过DescribeEipAddresses接口返回值中的eipId获取。

instanceId

String

机器实例ID。

可通过DescribeInstances接口返回值中的instanceId获取。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 代码示例

1. EIP绑定机器实例

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: AssociateEipAddress
<Common Request Params>

Request:
{
    "eipId": "eipId1"
    "instanceId": "instanceId1"
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {  
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码
错误码
说明

404

INVALID_EIP_NOT_FOUND

指定的EIP不存在。

403

INVALID_INSTANCE_NOT_FOUND

实例不存在。

403

OPERATION_DENIED_INSTANCE_RECYCLED

实例在回收站。

403

OPERATION_DENIED_INSTANCE_NOT_RUNNING

实例状态不是Running。

403

OPERATION_DENIED_EIP_ZONE_NOT_SAME

指定的EIP与实例区域不一致。

403

FAILED_OPERATION_FOR_RECYCLE_RESOURCE

指定的EIP在回收站。

400

OPERATION_DENIED_EIP_STATUS_NOT_AVAILABLE

指定的EIP状态不可用。

403

OPERATION_DENIED_EIP_ESXI_INSTANCE_ASSIGN

指定的EIP不支持ESXI实例。

403

OPERATION_DENIED_EIP_INSTANCE_EXCEED_LIMIT

实例绑定EIP数量超过限制。

最后更新于