1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
查询审计规则模板信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAuditRuleTemplates。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| RuleTemplateIds.N | 否 | Array of String | 规则模板ID。 示例值：cynosdb-art-nuzwpha1 |
| RuleTemplateNames.N | 否 | Array of String | 规则模板名称 示例值：测试template |
| Limit | 否 | Integer | 单次请求返回的数量。默认值20。 示例值：10 |
| Offset | 否 | Integer | 偏移量，默认值为 0。 示例值：0 |
| AlarmLevel | 否 | Integer | 告警等级。1-低风险，2-中风险，3-高风险。 示例值：1 |
| AlarmPolicy | 否 | Integer | 告警策略。0-不告警，1-告警。 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合查询条件的实例总数。 |
| Items | Array of AuditRuleTemplateInfo | 规则模板详细信息列表。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询审计规则模板信息
查询审计规则模板信息
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAuditRuleTemplates
<公共请求参数>
{
"RuleTemplateNames": [
"template_test"
],
"Limit": 10,
"Offset": 0
}输出示例
{
"Response": {
"Items": [
{
"CreateAt": "2022-12-06 00:54:01",
"Description": "all_template_des",
"RuleFilters": [
{
"Compare": "INC",
"Type": "sqlType",
"Value": [
"ALTER"
]
},
{
"Compare": "EQS",
"Type": "host",
"Value": [
"10.0.0.2"
]
},
{
"Compare": "NEQ",
"Type": "user",
"Value": [
"test"
]
},
{
"Compare": "INC",
"Type": "dbName",
"Value": [
"test"
]
}
],
"RuleTemplateId": "cynosdb-art-lcpm4as3",
"RuleTemplateName": "template_test"
}
],
"RequestId": "a19ebcfb-8b35-40f4-85ee-383109c9134b",
"TotalCount": 1
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。