查看分组下的告警规则 - ListGroupAlarmRules
功能介绍
分页查询指定告警分组下的告警规则列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/alarm-center/group/get-rule-list
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| page | 是 | Integer | 参数解释: 分页查询的页数。 约束限制: 不涉及。 取值范围: 大于等于1的整数。 默认取值: 1 |
| page_size | 是 | Integer | 参数解释: 每页最大返回的记录数。 约束限制: 不涉及。 取值范围: 大于等于1的整数。 默认取值: 10 |
| group_id | 是 | Long | 参数解释: 告警分组ID。 约束限制: 不涉及。 取值范围: 大于0的整数。 默认取值: 不涉及。 |
| keyword | 否 | String | 参数解释: 告警规则名称,支持模糊匹配。 约束限制: 不涉及。 取值范围: 字符串。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 从IAM服务获取的用户Token。获取方式请参见:获取Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rule_vos | Array of AlarmCenterRuleVO objects | 参数解释: 告警规则列表。 取值范围: 不涉及。 |
| total_count | Integer | 参数解释: 总记录数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 告警规则ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 告警规则名称。 取值范围: 不涉及。 |
| group_id | Long | 参数解释: 所属告警分组ID。 取值范围: 不涉及。 |
| group_name | String | 参数解释: 所属告警分组名称。 取值范围: 不涉及。 |
| gmt_create | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| gmt_create_timestamp | Long | 参数解释: 创建时间戳(毫秒)。 取值范围: 不涉及。 |
| expression | String | 参数解释: 告警表达式。 取值范围: 不涉及。 |
| context | String | 参数解释: 通知内容。 取值范围: 不涉及。 |
| level | String | 参数解释: 告警级别。 取值范围: 不涉及。 |
| enable | Boolean | 参数解释: 是否启用。 取值范围: 不涉及。 |
| eps_id | String | 参数解释: 企业项目ID。 取值范围: 不涉及。 |
| source | String | 参数解释: 应用类型。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
/v2/alarm-center/group/get-rule-list?page=1&page_size=10&groupId=3811&keyword
响应示例
状态码:200
{
"rule_vos" : [ {
"id" : 12191,
"name" : "alarm-rule",
"group_id" : 3811,
"group_name" : "alarm-group",
"gmt_create" : "2025-12-22 22:10:58",
"gmt_create_timestamp" : 1766412658000,
"expression" : "(cpuRatio>0)",
"context" : "${df}",
"level" : "COMMON",
"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 | 请求被拒绝访问。 |
错误码
请参见错误码。