CLI工具安装与快速入门-云监控(CMS)-阿里云帮助中心

云监控 2.0 CLI（aliyun cms2）是Aliyun CLI的一个插件，基于2024-03-30OpenAPI，提供云监控2.0的应用实时监控、Prometheus 监控、用户体验监控、告警规则、云拨测等能力的全生命周期管理。

安装与更新

参考安装/更新 CLI。

查看版本

aliyun cms2 --version

输出格式：

version: vX.Y.Z
git commit: <short-hash>
build date: <ISO8601>

配置凭证

参考配置与管理身份凭证。

输出格式

aliyun cms2支持以下结果输出格式：

text 格式（`-o text`，默认）

list 命令 → stdout：紧凑 CSV，首行为元数据注释 # <entity> returned=N total=T truncated=<true|false>，随后为表头行与数据行（列集合因命令而异，以各子命令 --help 为准）
get 命令 → stdout：单行紧凑 JSON {"success":true,"data":{...}}

JSON 格式（`-o json`）

成功 → stdout：
```
{
  "success": true,
  "data": {...}
}
```

失败 → stdout：

{
  "success": false,
  "error": {...}
}

成功与失败信封都写入 stdout，便于 cmd | jq 直接解析；stderr 仅用于告警、进度等辅助信息。命令失败时进程退出码非 0。

Prometheus 直通输出（例外）

metric promql labels、label-values、series 以及 query/query-range 输出原始 Prometheus HTTP API JSON（{"status": "success", "data": ...}），不包装在 CLI 的 success 信封中。

常见错误码

错误码	说明	处理建议
`InvalidArgument`	缺少或无效的必需参数	检查命令参数
`NotFound`	未知的资源 ID	重新执行对应的 list 命令
`Forbidden`	凭证权限不足	授予 AliyunCloudMonitorFullAccess 权限

命令概览

命令采用“资源 + 动作”的嵌套结构，例如 aliyun cms2 integration policy create。主要顶级命令：

命令	说明
`integration`	接入中心：集成策略（policy）、组件（addon）、组件发布（addon-release）、存储/大盘/采集目标等
`workspace`	工作区管理
`prometheus`	Prometheus 实例（instance）、视图（view）、聚合规则（recording-rule）
`grafana`	Grafana 工作区
`apm`	应用监控（APM）
`rum`	前端监控（RUM）
`synthetics`	云拨测（Synthetics）
`resource-watermark`	资源水位
`alert`	告警规则（rule）、告警模板（template）、告警历史（history）
`notification-channel`	通知渠道
`event-hub`	事件中心
`metric`	指标查询，含 PromQL 子命令（`metric promql ...`）
`entity`	实体（Entity）查询
`meta`	元数据查询
`trace`	链路追踪（Trace）
`aliyun-service`	阿里云服务开通状态查询
`commands`	列出全部命令

说明

完整命令树可通过 aliyun cms2 --help 或各级 <command> --help 查看。

快速入门示例

以下是使用 CLI 将 ACK 容器集群接入云监控的典型工作流：

# 1. 配置凭证
aliyun configure set \
  --access-key-id YOUR_AK --access-key-secret YOUR_SK \
  --region cn-hangzhou

# 2. 查看可用的接入组件
aliyun cms2 integration addon list
aliyun cms2 integration addon --addon-name cloud-acs-ack

# 3. 创建集成策略
aliyun cms2 integration policy create --body '{
  "policyType": "CS",
  "policyName": "my-ack-policy",
  "workspace": "default-cms-12345-cn-hangzhou",
  "entityGroup": {
    "clusterEntityType": "acs.ack.cluster",
    "clusterId": "c1234567890abcdef"
  }
}'

# 4. 部署组件
aliyun cms2 integration addon-release create --policy-id ip-xxx --body '{
  "addonName": "cloud-acs-ack",
  "version": "*",
  "envType": "CS",
  "workspace": "default-cms-12345-cn-hangzhou",
  "values": "{\"clusterId\":\"c1234567890abcdef\"}"
}'

# 5. 验证数据上报
aliyun cms2 metric promql query --prometheus-id pi-xxx --query 'up'