查询转发规则信息

1. 接口描述

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

本接口（DescribeRules）用于查询监听器下的所有规则信息，包括规则域名，路径以及该规则下所绑定的源站列表。当通道版本为3.0时，该接口会返回该域名对应的高级认证配置信息。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询转发规则信息

输入示例

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

{
    "ListenerId": "listener-qjm2tftd"
}

输出示例

{
    "Response": {
        "RequestId": "83a6736e-5550-4f9e-a2bf-c669e7b3a1d5",
        "TotalCount": 1,
        "DomainRuleSet": [
            {
                "Domain": "baidu.com",
                "IsDefaultServer": false,
                "DomainStatus": 0,
                "Http3Supported": 0,
                "BanStatus": "RECOVER",
                "RuleSet": [],
                "CertificateId": "default",
                "CertificateAlias": "默认证书",
                "ClientCertificateId": "default",
                "ClientCertificateAlias": "默认证书",
                "BasicAuthConfId": null,
                "BasicAuth": 0,
                "BasicAuthConfAlias": null,
                "RealServerCertificateId": null,
                "RealServerAuth": 0,
                "RealServerCertificateAlias": null,
                "RealServerCertificateDomain": null,
                "GaapCertificateId": null,
                "GaapAuth": 0,
                "GaapCertificateAlias": null,
                "PolyClientCertificateAliasInfo": [
                    {
                        "CertificateId": "default",
                        "CertificateAlias": "默认证书"
                    }
                ],
                "PolyRealServerCertificateAliasInfo": [],
                "TLSSupportVersion": [],
                "TLSCiphers": ""
            }
        ]
    }
}

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: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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