> 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/describebackends.md).

# DescribeBackends

## 1. 接口描述

本接口(DescribeBackends)用于查询负载均衡实例已绑定的后端服务及其转发配置。

## 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>如果未指定，则查询所有后端。</p><p>可通过调用 <a href="/api-reference/cn/zlb/load-balancer-listener/describelisteners.md">DescribeListeners</a> 获取。</p> |

## 3. 响应结果

| 参数名称      | 类型                                                                                 | 描述                                                       |
| --------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------- |
| requestId | String                                                                             | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| backends  | Array of [ListenerBackend](/api-reference/cn/zlb/datastructure.md#listenerbackend) | 负载均衡的后端服务器列表。                                            |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 查询负载均衡实例上绑定的所有后端服务。**

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

Request：
{
  "loadBalancerId": "<loadBalancerId>"
}

Response：
{
  "requestId": "T23120DD8-C59C-4919-8F73-E3F3892D3CDC",
  "response": {
    "requestId": "T23120DD8-C59C-4919-8F73-E3F3892D3CDC",
    "backends": [
      {
        "listenerId": "<listenerId>",
        "protocol": "TCP",
        "instanceId": "<instanceId>",
        "backendPort": 1,
        "listenerName": "Listener-TCP-01",
        "weight": 100,
        "listenerPort": "8080",
        "privateIpAddress": "10.0.0.1"
      }
    ]
  }
}
```

**2. 查询负载均衡实例上指定监听器上绑定的后端服务。**

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

Request：
{
  "loadBalancerId": "<loadBalancerId>",
  "listenerId": "<listenerId>"
}

Response：
{
  "requestId": "T23120DD8-C59C-4919-8F73-E3F3892D3CDC",
  "response": {
    "requestId": "T23120DD8-C59C-4919-8F73-E3F3892D3CDC",
    "backends": [
      {
        "listenerId": "<listenerId>",
        "protocol": "TCP",
        "instanceId": "<instanceId>",
        "backendPort": 1,
        "listenerName": "Listener-TCP-01",
        "weight": 100,
        "listenerPort": "8080",
        "privateIpAddress": "10.0.0.1"
      }
    ]
  }
}
```

{% 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状态码 | 错误码 | 说明 |
| ------- | --- | -- |