RegisterBackend

1. 接口描述

本接口用于将一台或多台后端服务绑定到负载均衡的监听器。

注意事项

  • 负载均衡实例的状态必须是RUNNING

  • 支持添加bmc的实例,要求实例的必须通过 云网络 L3 产品 与负载均衡器所属的VPC的边界网关建立联通。在添加bmc实例时,只需指定bmc实例的内网ip地址,不能填入实例ID。

2. 请求参数

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

参数名称
必选
类型
描述

loadBalancerId

String

负载均衡实例的 ID。

listenerId

String

负载均衡监听器的 ID。

backendServers

Array of BackendServer

要绑定的后端服务器列表。

注意:同一个实例在同一个监听器里只能存在一个。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

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

4. 代码示例

**1. 绑定一个后端机器到监听器上。 **

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

Request:
{
  "loadBalancerId": "<loadBalancerId>",
  "listenerId": "<listenerId>",
  "backendServers": [
    {
      "instanceId": "<instanceId>",
      "privateIpAddress": "10.0.0.1",
      "weight": 100
    }
  ]
}

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_LISTENER_NOT_FOUND

监听器不存在。

400

INVALID_INSTANCE_IP_ADDRESS

实例的内网IP不合法。

404

INVALID_INSTANCE_NOT_FOUND

后端服务器实例不存在。

409

INVALID_BACKEND_INSTANCE_LISTENER_EXIST

后端服务器已存在。

409

INVALID_BACKEND_INSTANCE_MULTIPLE

后端服务器重复。

400

INVALID_BACKEND_IP_ADDRESS

后端服务器的内网IP未找到相关实例。

409

INVALID_BACKEND_IP_ZBG_REQUIRED

加入的后端服务器IP需要VPC建立边界网关。

400

INVALID_BACKEND_SERVER_IP_INVALID

后端服务器IP不合法,必须为内网IP地址。

409

INVALID_BACKEND_SERVER_IP_REPEAT

后端服务器IP重复。

400

INVALID_BACKEND_SERVER_PORT

监听多个端口无法在指定端口。

400

INVALID_LB_STATUS

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

404

INVALID_BACKEND_ROUTE_NOT_FOUND

后端服务器IP路由未找到。

最后更新于