有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRules。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,此参数为可选参数。
ListenerId String 7层监听器Id。
示例值:listener-9jt0rtv9

3. 输出参数

参数名称 类型 描述
DomainRuleSet Array of DomainRuleSet 按照域名分类的规则信息列表
TotalCount Integer 该监听器下的域名总数
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询转发规则信息

输入示例

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

{
    "ListenerId": "listener-9jt0rtv9"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "DomainRuleSet": [
            {
                "GaapCertificateAlias": "xx",
                "Http3Supported": 0,
                "Domain": "xx",
                "CertificateId": "xx",
                "PolyRealServerCertificateAliasInfo": [
                    {
                        "CertificateId": "xx",
                        "CertificateAlias": "xx"
                    }
                ],
                "RealServerCertificateId": "xx",
                "BanStatus": "xx",
                "CertificateAlias": "xx",
                "ClientCertificateId": "xx",
                "GaapCertificateId": "xx",
                "BasicAuth": 1,
                "BasicAuthConfAlias": "xx",
                "BasicAuthConfId": "xx",
                "RealServerCertificateAlias": "xx",
                "RuleSet": [
                    {
                        "BindStatus": 1,
                        "Domain": "xx",
                        "RealServerType": "xx",
                        "ForwardHost": "xx",
                        "RuleId": "xx",
                        "HealthCheck": 1,
                        "ServerNameIndication": "xx",
                        "ListenerId": "xx",
                        "CheckParams": {
                            "Domain": "xx",
                            "ConnectTimeout": 1,
                            "BlockInter": 1,
                            "FailedThreshold": 1,
                            "Path": "xx",
                            "FailedCountInter": 1,
                            "Method": "xx",
                            "DelayLoop": 1,
                            "StatusCode": [
                                1,
                                1,
                                1,
                                1,
                                1
                            ]
                        },
                        "ForcedRedirect": "1",
                        "Scheduler": "xx",
                        "Path": "xx",
                        "RuleStatus": 1,
                        "ServerNameIndicationSwitch": "xx",
                        "RealServerSet": [
                            {
                                "RealServerStatus": 0,
                                "RealServerPort": 234,
                                "RealServerId": "xx",
                                "RealServerFailoverRole": "xx",
                                "DownIPList": [
                                    "xx"
                                ],
                                "RealServerWeight": 1,
                                "RealServerIP": "xx"
                            },
                            {
                                "RealServerStatus": 0,
                                "RealServerPort": 424,
                                "RealServerId": "xx",
                                "RealServerWeight": 1,
                                "RealServerFailoverRole": "xx",
                                "DownIPList": [
                                    "xx"
                                ],
                                "RealServerIP": "xx"
                            }
                        ]
                    }
                ],
                "PolyClientCertificateAliasInfo": [
                    {
                        "CertificateId": "xx",
                        "CertificateAlias": "xx"
                    }
                ],
                "GaapAuth": 1,
                "ClientCertificateAlias": "xx",
                "RealServerAuth": 1,
                "RealServerCertificateDomain": "xx",
                "DomainStatus": 1
            }
        ],
        "RequestId": "xx"
    }
}

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签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
AuthFailure.UnauthorizedOperation 子账户未授权操作。
FailedOperation 操作失败。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。
UnauthorizedOperation 未授权操作。