# RegisterBackend

## 1. 接口描述

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

## 2. 请求参数

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

<table><thead><tr><th width="174.38221528861155">参数名称</th><th width="81">必选</th><th width="172">类型</th><th>描述</th></tr></thead><tbody><tr><td>listenerId</td><td>是</td><td>String</td><td>监听器的ID。</td></tr><tr><td>backendName</td><td>是</td><td>String</td><td>后端配置服务器名称。<br>不得超过64个字符。仅支持输入字母、数字、-和英文句点(.)。</td></tr><tr><td>instanceId</td><td>是</td><td>String</td><td>裸金属实例ID。</td></tr><tr><td>clientToken</td><td>是</td><td>String</td><td>用于保证请求的幂等性。</td></tr><tr><td>portList</td><td>否</td><td>Array of Integer</td><td>端口列表。</td></tr><tr><td>weight</td><td>否</td><td>Integer</td><td>权重。</td></tr></tbody></table>

## 3. 响应结果

| 参数名称      | 类型     | 描述                                         |
| --------- | ------ | ------------------------------------------ |
| requestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。 |
| backendId | String | 后端配置服务器的ID。                                |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}

1. **将一台后端服务绑定到负载均衡的监听器**

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

Request:
{
  "listenerId": "xxxx",
  "backendName": "xxxx",
  "portList": [80],
  "clientToken": "xxxx",
  "weight": 100,
  "instanceId": "xxxx"
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "backendId": "xxxx"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

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

## 6. 错误码

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