AssociateEipAddress

1. 接口描述

本接口用于批量将弹性公网IP(EIP)绑定到同地域的云产品实例上。

注意事项

  • 你可以通过 DescribeLoadBalancers 接口来查看支持绑定负载均衡的实例。

  • 你可以通过 DescribeNetworkInterfaces 接口来查看支持绑定的虚拟网卡。

  • 你可以通过 DescribeNatGateways 接口来查看支持绑定的NAT网关。

  • 参数loadBalancerIdnicIdnatId必须传1个。如果3个字段值有带上,则按loadBalancerIdnicIdnatId顺序优先使用。

  • 如果遇到绑定数量超过了限制,可以联系Support来提高配额。

  • 接口会返回绑定失败的eip id集合,如果是空的则说明全部成功。

2. 请求参数

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

参数名称
必选
类型
描述

loadBalancerId

String

负载均衡实例的ID。

nicId

String

虚拟网卡的ID。

lanIp

String

要绑定的网卡上的内网IP地址。

当IP绑定的是网卡, 则该字段不能为空。

natId

String

NAT网关的ID。

eipIds

Array of String

要绑定的EIP的ID。

EIP 必须是未绑定状态。

bindType

绑定类型。

当绑定的是网卡时生效。

默认为普通NAT模式。

默认值:FullNat。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

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

failedEipIds

Array of String

绑定失败的IP。

4. 代码示例

1. 将多个弹性公网IP(EIP)绑定到指定网卡上, 并指定方式为可见模式。

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

Request:
{
  "nicId": "<nicId>",
  "lanIp": "10.0.0.2",
  "eipIds": ["<eipId1>","<eipId2>"],
  "bindType": "Passthrough"
}

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

2. 将多个弹性公网IP(EIP)绑定到指定负载均衡时实例上。

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

Request:
{
  "loadBalancerId": "<loadBalancerId>",
  "eipIds": ["<eipId1>","<eipId2>"]
}

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

3. 将多个弹性公网IP(EIP)绑定到指定NAT网关上。

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

Request:
{
  "natId": "<natId>",
  "eipIds": ["<eipId1>","<eipId2>"]
}

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_LB_NOT_FOUND

负载均衡器不存在。

400

INVALID_LB_STATUS

当前负载均衡器状态无法进行操作。

400

INVALID_REGION_MISMATCH

区域不匹配。

400

OPERATION_DENIED_EIP_ASSIGNED_LIMIT_EXCEEDED

EIP绑定超过数量限制。

最后更新于