告警规则管理

子命令概览

前提条件

• 已完成 CLI 工具安装与配置。

• 已创建 Prometheus 实例，并知道其所在工作空间（workspace）。

告警规则（alert rule）

alert rule create — 创建规则

通过 --body（内联 JSON 或 @file.json）提供规则内容，action 字段由 CLI 自动置为 CREATE。

# 从内联 JSON 创建（使用服务端 canonical 类型值）
aliyun cms2 alert rule create --body '{
  "workspace": "default-cms-12345-cn-hangzhou",
  "displayName": "ecs-cpu-high",
  "enabled": true,
  "queryConfig": {"type": "PROMETHEUS_SINGLE_QUERY", "promQl": "avg by (instanceId) (cpu_total)"},
  "conditionConfig": {"type": "PROMETHEUS_SIMPLE_CONDITION", "operator": "GT", "threshold": 90, "severity": "WARN"},
  "datasourceConfig": {"type": "PROMETHEUS", "instanceId": "prom-xxx"},
  "notifyConfig": {"type": "DIRECT_NOTIFY", "channels": [{"type": "GROUP", "identifiers": ["<contact-group-id>"]}]}
}'

# 从 JSON 文件创建
aliyun cms2 alert rule create --body @./rule.json

# 查看示例 body 与请求 schema
aliyun cms2 alert rule create --show-example-body
aliyun cms2 alert rule create --show-schema

# 本地校验而不实际创建
aliyun cms2 alert rule create --body @./rule.json --dry-run

Body 必需字段

canonical 类型值

• datasourceConfig.type：PROMETHEUS | SLS | APM | UMODEL

• queryConfig.type：PROMETHEUS_SINGLE_QUERY | PROMETHEUS_MULTI_QUERY | SLS_MULTI_QUERY | APM_MULTI_QUERY | UMODEL_METRICSET_QUERY

• channel.type：GROUP | CONTACT | DINGTALK | FEISHU | WEIXIN | SLACK | WEBHOOK

alert rule get — 查询单条规则

aliyun cms2 alert rule get --alert-rule-id ar-abc123

# JSON 输出
aliyun cms2 alert rule get --alert-rule-id ar-abc123 -o json

alert rule list — 查询规则列表

支持两种输入模式（互斥）：结构化 flag，或 --body 传完整 QueryAlertRulesInput。

# 按 workspace 查询
aliyun cms2 alert rule list --workspace default-cms-12345-cn-hangzhou

# 按名称搜索 + 仅启用规则
aliyun cms2 alert rule list --workspace my-ws --display-name "CPU" --enabled

# 仅禁用规则
aliyun cms2 alert rule list --workspace my-ws --disabled

# 按规则 ID 查询（单个或逗号分隔多个）
aliyun cms2 alert rule list --alert-rule-id "ar-1,ar-2,ar-3"

# 按标签过滤
aliyun cms2 alert rule list --workspace my-ws \
  --labels '{"allOf":[{"key":"severity","value":"critical"}]}'

# 分页（页码模式 或 token 模式）
aliyun cms2 alert rule list --workspace my-ws --page-number 2 --page-size 20
aliyun cms2 alert rule list --workspace my-ws --max-results 20 --next-token "eyJ..."

# 导出为 Prometheus YAML（--format prometheus 始终输出 YAML）
aliyun cms2 alert rule list --workspace my-ws --format prometheus > rules.yaml

# 文本（CSV）输出
aliyun cms2 alert rule list --workspace my-ws -o text

说明：

• 结构化模式至少提供 --workspace、过滤条件或分页 flag 之一。

• --format prometheus 仅转换 PromQL 规则，非 PromQL 规则跳过并在 stderr 输出 warning；组名会变为 datasource-{instanceId}，不可逆还原。

alert rule update — 全量替换规则

推荐工作流（get → 剥离只读字段 → 编辑 → update）：

# 1) 拉取当前规则并剥离服务端只读字段
aliyun cms2 alert rule get --alert-rule-id ar-abc123 -o json \
| jq '.data | del(.uuid, .createdAt, .updatedAt, .status, .gmtCreate, .gmtModified)' \
  > rule.body.json

# 2) 编辑 rule.body.json（如把阈值改为 95）
jq '.conditionConfig.threshold = 95' rule.body.json > rule.body.tmp && mv rule.body.tmp rule.body.json

# 3) 提交全量替换
aliyun cms2 alert rule update --alert-rule-id ar-abc123 --body @./rule.body.json

alert rule patch — 增量更新规则

patch 为真正的部分更新（PATCH 语义），未指定字段在服务端保留。两种输入模式互斥：--set key=value（可重复）或 --body（部分 JSON）。action 自动置为 PATCH，uuid 从 --alert-rule-id 注入。

# --set 模式（简单字段编辑，支持点号嵌套路径）
aliyun cms2 alert rule patch --alert-rule-id ar-xxx --set displayName="New Name"
aliyun cms2 alert rule patch --alert-rule-id ar-xxx --set conditionConfig.threshold=95

# --body 模式（部分 JSON，仅含要改的字段）
aliyun cms2 alert rule patch --alert-rule-id ar-xxx \
  --body '{"displayName":"New Name","enabled":false}'

alert rule delete — 删除规则

# 删除单条
aliyun cms2 alert rule delete --alert-rule-id ar-abc123

# 批量删除
aliyun cms2 alert rule delete --alert-rule-id "ar-abc123,ar-def456"

alert rule enable/disable — 批量启停

通过规则 ID 批量启用或禁用，立即生效，无交互确认。可先用 alert rule list 获取 ID。

# 启用（单个或批量）
aliyun cms2 alert rule enable --alert-rule-id ar-abc123
aliyun cms2 alert rule enable --alert-rule-id "ar-abc123,ar-def456"

# 禁用
aliyun cms2 alert rule disable --alert-rule-id ar-abc123

告警模板（alert template）

告警模板可复用规则配置，并通过 apply 批量生成具体告警规则。

# 列出模板（自定义 + 系统）
aliyun cms2 alert template list

# 按类型和来源过滤（is-system: 0=自定义 1=系统 -1=两者）
aliyun cms2 alert template list --alert-type PROMETHEUS_SINGLE_QUERY --is-system 0

# 查询模板详情（按 id 或 uuid）
aliyun cms2 alert template get --template-id 12345

# 创建自定义模板
aliyun cms2 alert template create --body @./template.json

# 更新 / 删除（仅自定义模板可删）
aliyun cms2 alert template update --template-id 12345 --body @./patch.json
aliyun cms2 alert template delete --template-id 12345

# 应用模板批量生成规则（Prometheus 模板需 --prometheus-instance-id）
aliyun cms2 alert template apply --template-id 12345 --workspace ws-xxx \
  --var namespace=prod --prometheus-instance-id prom-xxx \
  --contact-group-id cg-1

# 预览应用结果而不实际创建
aliyun cms2 alert template apply --template-id 12345 --workspace ws-xxx --dry-run

常用参数：

告警历史（alert history）

# 列出工作空间内的告警历史
aliyun cms2 alert history list --workspace default-cms-12345-cn-hangzhou

# 按级别和时间范围过滤（时间为 epoch 毫秒）
aliyun cms2 alert history list --workspace my-ws \
  --severity CRITICAL --from 1700000000000 --to 1700100000000

# 分页
aliyun cms2 alert history list --workspace my-ws --max-results 50 --next-token xxx

使用限制

• list 均为单页返回，不自动翻页。

• create/update/patch 的 body 不做完整服务端等价校验，最终以 API 返回为准。

• update 为全量替换，增量修改请用 patch。

• enable/disable/delete 通过 --alert-rule-id 操作，不支持按名称、标签批量筛选。

• --format prometheus 导出的 YAML 不保证 100% 还原原始分组名与高级配置。