> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/zlb/load-balancer-backend/registerbackend.md).

# RegisterBackend

## 1. 接口描述

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

{% hint style="info" %}
**注意事项**

* 负载均衡实例的状态必须为`RUNNING`。
* 支持添加BMC实例作为后端，但该实例必须已通过 **云网络L3产品** 与负载均衡所属VPC的边界网关建立连通。添加BMC实例时只需指定其内网IP地址，不能填写实例ID。
  {% endhint %}

## 2. 请求参数

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

| 参数名称           | 必选 | 类型                                                                             | 描述                                                                                                                                          |
| -------------- | -- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| loadBalancerId | 是  | String                                                                         | <p>负载均衡实例的ID。</p><p>可通过调用 <a href="/api-reference/cn/zlb/load-balancer-instance/describeloadbalancers.md">DescribeLoadBalancers</a> 获取。</p> |
| listenerId     | 是  | String                                                                         | <p>负载均衡监听器的ID。</p><p>可通过调用 <a href="/api-reference/cn/zlb/load-balancer-listener/describelisteners.md">DescribeListeners</a> 获取。</p>        |
| backendServers | 是  | Array of [BackendServer](/api-reference/cn/zlb/datastructure.md#backendserver) | <p>要绑定的后端服务器列表。</p><p>注意：同一个实例在同一个监听器里只能存在一个。</p>                                                                                           |

## 3. 响应结果

| 参数名称      | 类型     | 描述                                                       |
| --------- | ------ | -------------------------------------------------------- |
| requestId | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 绑定一个后端机器到监听器上。**

```json
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"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码                                         | 说明                          |
| ------- | ------------------------------------------- | --------------------------- |
| 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              | DR模式、全端口或监听多个端口无法指定后端服务器端口。 |
| 400     | INVALID\_INSTANCE\_IP\_ADDRESS              | 实例的内网IP不合法。                 |
| 404     | INVALID\_INSTANCE\_NOT\_FOUND               | 服务器实例不存在。                   |
| 404     | INVALID\_LB\_LISTENER\_NOT\_FOUND           | 监听器不存在。                     |
| 400     | INVALID\_LB\_STATUS                         | 当前负载均衡器状态无法进行操作。            |
| 400     | INVALID\_RS\_QUOTA\_EXCEED\_PER\_LISTENER   | 监听器下后端服务器数量超过配额。            |