更新时间:2026-11-20 GMT+08:00
分享

查看告警分组 - ListAlarmGroups

功能介绍

分页查询告警分组列表,支持按名称模糊搜索、按企业项目和应用类型过滤。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/alarm-center/group/get-group-list

表1 Query参数

参数

是否必选

参数类型

描述

page

否

Integer

参数解释:

分页查询的页数。

约束限制:

不涉及。

取值范围:

大于等于1的整数。

默认取值:

1

page_size

否

Integer

参数解释:

每页最大返回的记录数。

约束限制:

不涉及。

取值范围:

大于等于1的整数。

默认取值:

10

keyword

否

String

参数解释:

模板名称,支持模糊匹配。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

id

否

Long

参数解释:

告警分组ID。

约束限制:

不涉及。

取值范围:

大于0的整数。

默认取值:

不涉及。

order_by

否

String

参数解释:

排序规则。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

eps_id

否

String

参数解释:

企业项目ID。

约束限制:

不涉及。

取值范围:

字符串。

默认取值:

不涉及。

source

否

String

参数解释:

应用类型。

约束限制:

不涉及。

取值范围:

  • APM2:增强型探针。

  • TRACING:skywalking。

  • OTEL:OpenTelemetry。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

从IAM服务获取的用户Token。获取方式请参见:获取Token。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

group_vos

Array of AlarmCenterGroup objects

参数解释:

告警分组列表。

total_count

Integer

参数解释:

总记录数。

取值范围:

不涉及。

表4 AlarmCenterGroup

参数

参数类型

描述

id

Long

参数解释:

告警分组ID。

取值范围:

不涉及。

name

String

参数解释:

告警分组名称。

取值范围:

不涉及。

gmt_create

String

参数解释:

创建时间。

取值范围:

不涉及。

rule_list

Array of strings

参数解释:

分组下的告警规则列表。

enable

Boolean

参数解释:

是否启用。

取值范围:

  • true:启用

  • false:禁用

description

String

参数解释:

告警分组描述。

取值范围:

不涉及。

eps_id

String

参数解释:

企业项目ID。

取值范围:

不涉及。

source

String

参数解释:

应用类型。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

请求示例

/v2/alarm-center/group/get-group-list

响应示例

状态码:200

{
  "group_vos" : [ {
    "description" : "",
    "id" : 3807,
    "name" : "alarm_group",
    "gmt_create" : "2025-12-22 21:05:10",
    "rule_list" : [ "alarm_rule" ],
    "enable" : false,
    "eps_id" : "0",
    "source" : "APM2"
  } ],
  "total_count" : 1
}

状态码:400

"{\n  \"error_code\": \"apm2.00000005\",\n  \"error_msg\": \"invalid parameter\"\n}"

状态码:403

"{\n  \"error_code\": \"apm2.00000004\",\n  \"error_msg\": \"has no privilege\"\n}"

状态码

状态码

描述

200

查询告警分组成功。

400

非法请求,建议根据error_msg检查修改该请求。

403

请求被拒绝访问。

错误码

请参见错误码。

相关文档