文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>应用型负载均衡>API 文档>转发规则相关接口>查询转发规则

查询转发规则

最近更新时间：2026-07-07 10:57:50

我的收藏

本页目录：

1. 接口描述

接口请求域名： alb.tencentcloudapi.com 。

查询转发规则

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRules。
Version 是 String 公共参数，本接口取值：2025-10-30。
Region 是 String 公共参数，详见产品支持的 地域列表。
ListenerId 是 String 监听器 ID，格式为 lst- 后接 8 位字母数字。
示例值：lst-d9p3k7wa
LoadBalancerId 是 String 负载均衡实例 ID，格式为 alb- 后接 8 位字母数字。
示例值：alb-f8q2xk9m
Filters.N 否 Array of Filter 支持的过滤条件如下：
MaxResults 否 Integer 返回列表的数量，默认为20，最大值为100。
示例值：20
NextToken 否 String 下一次查询的Token值。第一次查询和没有下一次查询时，无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。
示例值：3974ae26e***
RuleIds.N 否 Array of String 转发规则 ID 列表，ID 格式为 rule- 后接 8 位字母数字。
示例值：["rule-h8cy5gwl"]

3. 输出参数

参数名称 类型 描述
NextToken String 下一次查询的Token值，如果当前是最后一页，返回为空。
示例值：3974ae26e***
Rules Array of RuleOutput 转发规则列表。
TotalCount Integer 总的转发规则个数（根据监听器ID、规则ID等条件过滤后）。
示例值：3
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询规则列表

输入示例

POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRules
<公共请求参数>

{
    "LoadBalancerId": "alb-f8q2xk9m",
    "ListenerId": "lst-d9p3k7wa",
    "MaxResults": 100
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "NextToken": "",
        "Rules": [
            {
                "RuleId": "rule-h8cy5gwl",
                "Priority": 1,
                "RuleName": "rule1",
                "Direction": "Request",
                "Conditions": [
                    {
                        "Type": "Host",
                        "HostConfig": [
                            "test.com"
                        ]
                    }
                ],
                "Actions": [
                    {
                        "Type": "TargetGroup",
                        "Order": 1,
                        "TargetGroupConfig": {
                            "TargetGroups": [
                                {
                                    "TargetGroupId": "lbtg-0zrnc9qa",
                                    "Weight": 10
                                }
                            ]
                        }
                    }
                ],
                "Status": "Active",
                "Tags": []
            }
        ],
        "RequestId": "ed300290-70cc-41f6-af02-50e151f91f90"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidFilter 无效的过滤器
InvalidParameter 参数错误。
InvalidParameter.InvalidFieldType 字段类型错误。
InvalidParameter.InvalidFieldValue 字段值错误。
InvalidParameter.MissingAction 缺少 Action 参数。
InvalidParameter.MissingField 请填写必要参数。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RegionError 地域错误
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceNotFound 资源不存在。
ResourceNotFound.Listener 监听器未找到。
ResourceNotFound.LoadBalancer 负载均衡资源不存在。
ResourceNotFound.Rule 转发规则未找到
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.ServiceRoleUnauthorized 服务角色未授权
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站