Help Center/ SecMaster/ API Reference/ SecMaster APIs (V2)/ Alert Rule Template Management/ Querying the Alert Rule Template Overview

Updated on 2025-12-18 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Alert Rule Template Overview

Function

This API is used to query the alert rule template overview.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/alert-rules/templates/metrics

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Workspace ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
severity	severity object	Alert severity statistics.
status	status object	Alert rule statistics by status.

**Table 4** severity
Parameter	Type	Description
metric	metric object	Severity statistics details.
category	String	Classification method.

**Table 5** metric
Parameter	Type	Description
HIGH	Integer	The number of HIGH alerts.
TIPS	Integer	The number of TIPS alerts.
FATAL	Integer	The number of FATAL alerts.
LOW	Integer	The number of LOW alerts.
MEDIUM	Integer	The number of MEDIUM alerts.

**Table 6** status
Parameter	Type	Description
metric	metric object	Status details.
category	String	Classification method.

**Table 7** metric
Parameter	Type	Description
activity	Integer	The number of active alert rules.
ENABLED	Integer	The number of enabled alert rules.
DISABLED	Integer	The number of disabled alert rules.

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	Successful.

Error Codes

See Error Codes.

Parent topic: Alert Rule Template Management

Previous topic: Viewing an Alert Rule Template

Next topic: Security Analysis

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.