Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Alert Rule Template Management/ Querying the Alert Rule Template Overview
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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

{User defined key}

Map<String,Object>

Nested hash table structure of the returned object.
Table 4 InnerHashTable

Parameter

Type

Description

{User defined key}

Map<String,Object>

Content.
Table 5 InnerHashTableValue

Parameter

Type

Description

{User defined key}

Map<String,Integer>

Content.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success

Error Codes

See Error Codes.