> 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-instance/describeloadbalancers.md).
# DescribeLoadBalancers
## 1. 接口描述
本接口(DescribeLoadBalancers)用于查询负载均衡实例列表。
## 2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
| 参数名称 | 必选 | 类型 | 描述 |
| ---------------- | -- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| regionId | 否 | String | 节点ID。
可通过调用 DescribeRegions 获取。
|
| vpcId | 否 | String | 根据负载均衡后端服务器所属的VPC网络ID过滤。
可通过调用 DescribeVpcs 获取。
|
| ipStackType | 否 | [LoadBalancerIpStackType](/api-reference/cn/zlb/datastructure.md#loadbalanceripstacktype) | 根据IP堆栈类型过滤。
负载均衡实例只支持单栈，即IPv4或IPv6。
|
| loadBalancerIds | 否 | Array of String | 负载均衡实例ID集合。
实例ID数量上限为100个。
|
| loadBalancerName | 否 | String | 负载均衡实例名称。
可以在末尾加入\*以支持模糊匹配。
|
| pageSize | 否 | Integer | 返回的分页大小。
默认为20，最大为1000。
|
| pageNum | 否 | Integer | 返回的分页页码。
默认值：1
|
| resourceGroupId | 否 | String | 根据资源组ID进行过滤。 |
| tagKeys | 否 | Array of String | 根据标签键进行搜索。
最长不得超过20个标签键。
|
| tags | 否 | Array of [Tag](/api-reference/cn/zlb/datastructure.md#tag) | 根据标签进行搜索。
最长不得超过20个标签。
|
| securityGroupId | 否 | String | 负载均衡实例绑定的安全组ID。
可通过调用 DescribeSecurityGroups 获取。
|
## 3. 响应结果
| 参数名称 | 类型 | 描述 |
| ---------- | ---------------------------------------------------------------------------- | -------------------------------------------------------- |
| requestId | String | 唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 requestId。
|
| totalCount | Integer | 满足过滤条件的负载均衡实例总数。 |
| dataSet | Array of [LoadBalancer](/api-reference/cn/zlb/datastructure.md#loadbalancer) | 返回的负载均衡实例列表。 |
## 4. 代码示例
{% tabs %}
{% tab title="示例" %}
**1. 查看负载均衡实例列表。**
```json
POST /api/v2/zlb HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeLoadBalancers
Request：
{
}
Response：
{
"requestId": "TC073A2C6-3923-48AD-960F-446CBF303A2A",
"response": {
"requestId": "TC073A2C6-3923-48AD-960F-446CBF303A2A",
"totalCount": 6,
"dataSet": [
{
"loadBalancerId": "",
"listenerCount": 0,
"backendServerCount": 0,
"regionId": "asia-east-1",
"publicIpAddress": [
"128.xx.xx.1"
],
"privateIpAddress": [
"10.xx.xx.1"
],
"securityGroupId":"",
"healthCheckPrivateIps": [
"128.xx.xx.100",
"128.xx.xx.101"
],
"resourceGroup": {
"resourceGroupName": "Default Resource Group",
"resourceGroupId": ""
},
"createTime": "2025-04-01T01:01:01Z",
"loadBalancerName": "sample-load-balancer",
"vpcId": "",
"subnetId": "",
"ipStackType": "IPv4",
"status": "RUNNING",
"tags":null
},
{
"loadBalancerId": "",
"listenerCount": 0,
"backendServerCount": 0,
"regionId": "asia-east-1",
"publicIpAddress": [
"2001:db8::/96"
],
"privateIpAddress": [
"10.xx.xx.2"
],
"securityGroupId":"",
"healthCheckPrivateIps": [
"2001:db8:1::/96",
"2001:db8:2::/96"
],
"resourceGroup": {
"resourceGroupName": "Default Resource Group",
"resourceGroupId": ""
},
"createTime": "2025-04-01T01:01:01Z",
"loadBalancerName": "sample-ipv6-load-balancer",
"vpcId": "",
"subnetId": "",
"ipStackType": "IPv6",
"status": "RUNNING",
"tags":null
}
]
}
}
```
上面一并列出了两种堆栈类型，注意 `publicIpAddress` 的形态差异：`IPv4` 类型返回单个地址， `IPv6` 类型返回**带掩码的网段**（VIP是从子网IPv6网段里切出的一段，不是单个地址）。
{% 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状态码 | 错误码 | 说明 |
| ------- | --- | -- |