1. 接口描述
接口请求域名: alb.tencentcloudapi.com 。
查询实例配置。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeLoadBalancers。 |
| Version | 是 | String | 公共参数,本接口取值:2025-10-30。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 查询过滤条件,支持以下几个字段 - LoadBalancerId: 负载均衡实例 ID - LoadBalancerName: 负载均衡名称 - LoadBalancerStatus: 负载均衡状态 - VpcId: 私有网络 ID - tag:tag-key:按标签键值对筛选,tag-key 请替换为实际的标签键。例如 tag:env 表示按标签键 env 筛选。- AddressType: 网络类型 - Intranet: 内网 - Internet: 公网 - AddressIpVersion: - IPv4: IPv4 地址 - IPv6 IPv6 地址 |
| MaxResults | 否 | Integer | 分批次查询时每次显示的条目数。取值范围:1~100,默认值:20。 示例值:20 |
| NextToken | 否 | String | 是否拥有下一次查询的令牌(Token)。取值: - 第一次查询和没有下一次查询时,均无需填写。 - 如果有下一次查询,取值为上一次API调用返回的NextToken值。 示例值:FFmyTO70tTpLG6I3FmYAXGKPd8r6k |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoadBalancers | Array of LoadBalancer | 应用型负载均衡实例列表。 |
| MaxResults | Integer | 分批次查询时每次显示的条目数。 示例值:20 |
| NextToken | String | 是否拥有下一次查询的令牌(Token)。取值: - 如果NextToken为空表示没有下一次查询。 - 如果NextToken有返回值,该取值表示下一次查询开始的令牌。 示例值:FFmyTO70tTpLG6I3FmYAXGKPd8r6k |
| TotalCount | Integer | 列表条目数。 示例值:100 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询负载均衡实例列表
输入示例
POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancers
<公共请求参数>
{
"MaxResults": 1
}
输出示例
{
"Response": {
"LoadBalancers": [
{
"AddressIpVersion": "IPv4",
"AddressType": "Internet",
"CreateTime": "2026-05-25 18:27:42",
"DeletionProtection": {
"DeletionProtectionEnabled": false,
"Reason": ""
},
"Domain": "alb-f8q2xk9m-c0rpri8t217fy3ii.gz-tencentalb.com",
"LoadBalancerBillingConfig": {
"BandwidthPackageId": "bwp-q8m2x4pa",
"ChargeType": "POSTPAID_BY_HOUR"
},
"LoadBalancerId": "alb-f8q2xk9m",
"LoadBalancerName": "alb-f8q2xk9m",
"LoadBalancerOperationLocks": [],
"LoadBalancerStatus": "Active",
"ModificationProtection": {
"ModificationProtectionEnabled": false,
"OperatorUin": "",
"Reason": ""
},
"Tags": [],
"VpcId": "vpc-92hffaxb"
}
],
"MaxResults": 1,
"NextToken": "eyJsYXN0X3Jlc291cmNlX2lkIjogImFsYi01cWw0MHZzayIsICJsYXN0X2RiX2lkIjogNjY1MCwgInRvdGFsX2NvdW50IjogMjd9",
"TotalCount": 27,
"RequestId": "d635fb06-fa8a-41fe-bb34-ef1b0615364f"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。