接入管理-云监控(CMS)-阿里云帮助中心

当需要将云服务、容器（ACK）、ECS 应用等监控数据统一接入云监控时，可通过 CLI 工具 aliyun cms2 的 integration 命令组完成全流程管理。接入以"集成策略（policy）+ 组件发布（addon-release）"为核心模型：先创建集成策略定义接入范围，再在策略下部署一个或多个接入组件（addon）采集监控数据。

子命令概览

子命令	说明
`integration addon`	查询组件目录（元数据、参数 schema、代码模板），接入前的第一步
`integration policy`	管理集成策略（创建、查询、更新、删除、列表）
`integration addon-release`	在策略下管理组件发布（部署、查询、更新、删除）
`integration collector` / `custom-job` / `service-monitor` / `pod-monitor` / `job-target`	查询采集器、自定义采集任务及采集目标
`integration dashboard` / `storage` / `resource`	查询接入策略关联的大盘、存储需求与资源
`integration check-collector-target`	预检采集目标连通性与指标分析
`integration check-scrape-config`	试运行已部署的抓取配置（服务发现与 relabel 验证）

前提条件

已完成 CLI 工具安装与配置。
拥有目标阿里云账号的 AccessKey，且已授予 AliyunCloudMonitorFullAccess 权限。
已创建工作空间（workspace），通常形如 default-cms-{userId}-{regionId}。

典型接入流程

以下示例演示从组件发现到部署验证的完整接入过程：

# 1. 发现可用组件，查看参数 schema 与接入指引
aliyun cms2 integration addon list --search ack
aliyun cms2 integration addon --addon-name cloud-acs-ack

# 2. 创建集成策略
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"
  }
}'
# → 返回 policyId，如 ip-abc123

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

# 4. 验证部署
aliyun cms2 integration addon-release list --policy-id ip-abc123

组件目录（integration addon）

组件目录是接入的自动发现机制。接入任何云服务前，建议先通过 integration addon 相关子命令查看组件的 policyType、envType 以及 values 参数 schema。

integration addon — 查看组件详情

指定 --addon-name 时输出组件元数据、参数 schema 与接入指引。部分 API 调用失败时仍可返回已获取的信息。

查看组件完整信息（元数据 + schema + 接入指引）：

aliyun cms2 integration addon --addon-name cloud-acs-ack

指定环境类型：

aliyun cms2 integration addon --addon-name cloud-acs-ack --env-type CS

参数	类型	说明
`--addon-name`	string	组件名称（指定后展示详情与接入指引）
`--env-type`	string	环境类型（`CS`/`ECS`/`Cloud`）
`--version`	string	组件版本（默认最新）
`--aliyun-lang`	string	语言（`zh`/`en`，默认 `zh`）

integration addon list — 列出组件

列出所有组件：

aliyun cms2 integration addon list

按分类过滤：

aliyun cms2 integration addon list --category database

按关键字搜索：

aliyun cms2 integration addon list --search ack

按实体类型过滤（OR 语义，逗号分隔）：

aliyun cms2 integration addon list --entity-type acs.ecs.instance,acs.rds.instance

参数	类型	说明
`--category`	string	按分类过滤（如 `database`）
`--search`	string	按关键字过滤
`--entity-type`	string	按实体类型过滤（逗号分隔，OR 语义）
`--aliyun-lang`	string	语言（`zh`/`en`，默认 `zh`）

integration addon get — 获取组件详情

组合 GetAddon、GetAddonSchema、GetAddonCodeTemplate 三个 API，返回组件元数据、参数 schema 与代码模板。任一 API 失败即命令失败；如需在部分 API 失败时仍返回可用信息，请改用 integration addon --addon-name。

aliyun cms2 integration addon get --addon-name cloud-acs-ack --env-type CS

参数	类型	说明
`--addon-name`	string	组件名称（必填）
`--env-type`	string	环境类型（`CS`/`ECS`/`Cloud`）
`--version`	string	组件版本（默认最新）
`--aliyun-lang`	string	语言（`zh`/`en`，默认 `zh`）

集成策略（integration policy）

integration policy create — 创建策略

云服务接入策略：

aliyun cms2 integration policy create --body '{
  "policyType": "Cloud",
  "policyName": "my-rds-policy",
  "workspace": "default-cms-12345-cn-hangzhou"
}'

容器（ACK）接入策略：

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"
  }
}'

从 JSON 文件创建：

aliyun cms2 integration policy create --body @./policy.json

参数	类型	说明
`--body`	string	请求 body，内联 JSON 或 `@file.json`（必填）
`--show-example-body`	bool	打印示例请求 body 后退出
`--show-schema`	bool	打印请求 body 的 JSON schema 后退出

Body 必需字段

字段	说明
`policyType`	策略类型，如 `CS`、`ECS`、`Cloud`（由组件目录决定）
`policyName`	策略名称（非空）
`workspace`	工作空间名称

容器场景（policyType=CS）还需 entityGroup.clusterEntityType（acs.ack.cluster）和 entityGroup.clusterId（ACK 集群 ID）。跨账号场景可通过 entityGroup.entityUserId 指定目标实例所属账号 UID。命令执行成功后响应返回生成的 policyId（如 ip-abc123）。

integration policy get — 查询策略

aliyun cms2 integration policy get --policy-id ip-abc123def456

参数	类型	说明
`--policy-id`	string	集成策略 ID（必填）

integration policy update — 更新策略

仅修改 body 中包含的字段。常用于重命名、修改 feePackage、更新 resourceGroupId 或 tags。

aliyun cms2 integration policy update --policy-id ip-abc123def456 --body '{
  "policyName": "new-policy-name",
  "feePackage": "CS_Pro",
  "resourceGroupId": "rg-aekzoiafjtr7zyq",
  "tags": [{"key": "env", "value": "production"}]
}'

参数	类型	说明
`--policy-id`	string	集成策略 ID（必填）
`--body`	string	请求 body，内联 JSON 或 `@file.json`（必填）

integration policy delete — 删除策略

删除策略时会级联删除其下的组件发布，无需事先单独删除。

警告

删除操作不可逆。

aliyun cms2 integration policy delete --policy-id ip-abc123def456

参数	类型	说明
`--policy-id`	string	集成策略 ID（必填）

integration policy list — 列出策略

# 列出所有策略
aliyun cms2 integration policy list

# 按类型过滤
aliyun cms2 integration policy list --policy-type CS

# 按工作空间和区域过滤
aliyun cms2 integration policy list --workspace default-cms-12345-cn-hangzhou \
  --filter-region-ids cn-hangzhou,cn-shanghai

# 关键字搜索
aliyun cms2 integration policy list --query my-policy

# 分页查询
aliyun cms2 integration policy list --max-results 10 --next-token "eyJ..."

参数	类型	说明
`--policy-type`	string	按策略类型过滤（`CS`、`ECS`、`Cloud` 等）
`--policy-id`	string	按策略 ID 过滤
`--policy-name`	string	按策略名称过滤
`--workspace`	string	按工作空间过滤
`--filter-region-ids`	string	按区域 ID 过滤（逗号分隔）
`--prometheus-id`	string	按 Prometheus 实例 ID 过滤
`--bind-resource-id`	string	按绑定资源 ID 过滤
`--entity-group-ids`	string	按实体组 ID 过滤（逗号分隔）
`--resource-group-id`	string	按资源组 ID 过滤
`--addon-name`	string	按组件名称过滤
`--query`	string	关键字过滤
`--tag`	string	标签过滤（JSON 数组，如 `'[{"key":"env","value":"prod"}]'`）
`--max-results`	int32	最大返回数量（默认 30，最大 100）
`--next-token`	string	分页 token

组件发布（integration addon-release）

组件发布代表一个已部署的监控组件，包含名称、版本、参数值（values，转义 JSON 字符串）和环境类型。所有子命令均需 --policy-id 指定父级集成策略。

integration addon-release create — 部署组件

CS 组件（values 携带集群参数）：

aliyun cms2 integration addon-release create --policy-id ip-abc123 --body '{
  "addonName": "cloud-acs-ack", "version": "*", "envType": "CS",
  "workspace": "default-cms-12345-cn-hangzhou",
  "values": "{\"clusterId\":\"c123\",\"clusterName\":\"my-cluster\"}"
}'

Cloud 组件——按实体类型与区域接入：

aliyun cms2 integration addon-release create --policy-id ip-abc123 --body '{
  "addonName": "cloud-rds", "version": "1.2.29", "envType": "Cloud",
  "workspace": "my-ws", "values": "{}",
  "entityRules": { "entityTypes": ["acs.rds.instance"], "regionIds": ["cn-hangzhou"] }
}'

从 JSON 文件部署：

aliyun cms2 integration addon-release create --policy-id ip-abc123 --body @./release.json

参数	类型	说明
`--policy-id`	string	集成策略 ID（必填）
`--body`	string	请求 body，内联 JSON 或 `@file.json`（必填）
`--show-example-body`	bool	打印示例请求 body 后退出
`--show-schema`	bool	打印请求 body 的 JSON schema 后退出

Body 必需字段

字段	说明
`addonName`	组件名称（来自组件目录，如 `cloud-acs-ack`）
`version`	组件版本（`*` 表示最新）
`envType`	环境类型（`CS`/`ECS`/`Cloud`，来自组件 schema）
`workspace`	工作空间名称
`values`	转义的 JSON 字符串，符合组件参数 schema，如 `"{\"clusterId\":\"c123\"}"`

说明

values 是转义的 JSON 字符串，不是嵌套对象。
Cloud 类型组件可选 entityRules 顶层字段控制监控范围：entityTypes（必填，不支持通配符）、regionIds（可选），并可用 resourceGroupId / tags / instanceIds 之一进一步限定范围。
跨账号 CS 接入时 values.feePackage 必须为 CS_Pro。
部署前建议用 integration addon get --addon-name <NAME> 查看 dependencies.services，并用 aliyun-service status --service-name <svc> 确认依赖服务已开通（名称含 role 的为服务关联角色，跳过）。

查询组件发布（integration addon-release get）

release-id 可从 addon-release create 的响应或 addon-release list 的输出中获取。

aliyun cms2 integration addon-release get --policy-id ip-abc123 --release-id <id>

参数	类型	说明
`--policy-id`	string	集成策略 ID（必填）
`--release-id`	string	组件发布 ID（必填）

列出组件发布（integration addon-release list）

aliyun cms2 integration addon-release list --policy-id ip-abc123

参数	类型	说明
`--policy-id`	string	集成策略 ID（必填）

更新组件发布（integration addon-release update）

aliyun cms2 integration addon-release update --policy-id ip-abc123 --body @./release-update.json

参数	类型	说明
`--policy-id`	string	集成策略 ID（必填）
`--body`	string	请求 body，内联 JSON 或 `@file.json`（必填）

删除组件发布（integration addon-release delete）

release-id 可从 addon-release create 的响应或 addon-release list 的输出中获取。

aliyun cms2 integration addon-release delete --policy-id ip-abc123 --release-id <id>

参数	类型	说明
`--policy-id`	string	集成策略 ID（必填）
`--release-id`	string	组件发布 ID（必填）

使用限制

list 类命令为单页请求，不自动翻页，需根据响应中的 nextToken 手动请求下一页。
create/update 的 body 不做 CLI 侧 Schema 校验，字段级约束由 API 校验。
--tag 必须是 JSON 数组，字段名小写：[{"key":"k","value":"v"}]。
各子命令的具体参数请以 aliyun cms2 integration <子命令> --help 为准。