文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V2/ 告警规则模板管理/ 列出告警规则模板总览 - ListAlertRuleTemplateMetrics
更新时间:2025-12-12 GMT+08:00
分享

列出告警规则模板总览 - ListAlertRuleTemplateMetrics

功能介绍

列出告警规则模板总览

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

severity

severity object

告警等级统计

status

status object

告警规则状态统计

表4 severity

参数

参数类型

描述

metric

metric object

等级统计详情

category

String

分类方式

表5 metric

参数

参数类型

描述

HIGH

Integer

HIGH等级数量

TIPS

Integer

TIPS等级数量

FATAL

Integer

FATAL等级数量

LOW

Integer

LOW等级数量

MEDIUM

Integer

MEDIUM等级数量

表6 status

参数

参数类型

描述

metric

metric object

状态详情

category

String

分类方式

表7 metric

参数

参数类型

描述

activity

Integer

活跃状态数量

ENABLED

Integer

启用状态数量

DISABLED

Integer

禁用状态数量

请求示例

响应示例

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档