1. 接口描述
接口请求域名： teo.tencentcloudapi.com 。
查询规则引擎规则。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRules。 |
| Version | 是 | String | 公共参数，本接口取值：2022-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 站点 ID。 |
| Filters.N | 否 | Array of Filter | 过滤条件，Filters.Values的上限为20。详细的过滤条件如下： 按照【规则ID】进行过滤。 类型：string 必选：否 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ZoneId | String | 站点 ID。 |
| RuleItems | Array of RuleItem | 规则列表，按规则执行顺序从先往后排序。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeRules
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRules
<公共请求参数>
{
"ZoneId": "zone-kwsqufps"
}输出示例
{
"Response": {
"RequestId": "5f24d792-050d-439f-a864-353fd7b67e9f",
"RuleItems": [
{
"RuleId": "rule-2picazk4qsq9",
"RuleName": "未命名规则",
"RulePriority": 1,
"Rules": [
{
"Actions": [
{
"CodeAction": null,
"NormalAction": {
"Action": "Cache",
"Parameters": [
{
"Name": "Type",
"Values": [
"Cache"
]
},
{
"Name": "Switch",
"Values": [
"on"
]
},
{
"Name": "IgnoreCacheControl",
"Values": [
"off"
]
},
{
"Name": "CacheTime",
"Values": [
"100"
]
}
]
},
"RewriteAction": null
}
],
"Conditions": [
{
"Conditions": [
{
"IgnoreCase": false,
"IgnoreNameCase": false,
"Operator": "equal",
"Target": "host",
"Name": "",
"Values": [
"corki.chris-v.com"
]
}
]
}
],
"SubRules": []
}
],
"Status": "enable",
"Tags": []
}
],
"ZoneId": "zone-2p7d5y3b8l8k"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.RouteError | 后端服务路由地址错误。 |
| UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
| UnauthorizedOperation.Unknown | 后端服务器发生未知错误。 |