DescribeAuditRuleTemplates

最后更新时间：2026-01-19 15:59:58

DescribeAuditRuleTemplates

最后更新时间： 2026-01-19 15:59:58

1. API Description

Domain name for API request: cdb.intl.tencentcloudapi.com.

This API is used to query the information of audit rule templates.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeAuditRuleTemplates.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
RuleTemplateIds.N	No	Array of String	Rule template ID.
RuleTemplateNames.N	No	Array of String	Rule template name.
Limit	No	Integer	Number of entries to return per request. Default value: 20. Maximum value: 1000.
Offset	No	Integer	Offset. Default value: 0.
AlarmLevel	No	Integer	Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk.
AlarmPolicy	No	Integer	Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of eligible instances.
Items	Array of AuditRuleTemplateInfo	List of rule template details.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying Audit Rule Template Information

None

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAuditRuleTemplates
<Common request parameters>

{
    "RuleTemplateNames": [
        "template_1"
    ],
    "Limit": 10,
    "Offset": 0
}

Output Example

{
    "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": [
                            "lue"
                        ]
                    },
                    {
                        "Compare": "INC",
                        "Type": "dbName",
                        "Value": [
                            "lue"
                        ]
                    }
                ],
                "RuleTemplateId": "cdb-art-lcpm4as3",
                "RuleTemplateName": "template_test"
            }
        ],
        "RequestId": "a19ebcfb-8b35-40f4-85ee-383109c9134b",
        "TotalCount": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.DBOperationActionError	Database operation failed.
InvalidParameter.ControllerNotFoundError	This API was not found.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud