用途
gws-alertcenter 是 googleworkspace/cli 技能集中的一部分,用于在命令行中管理 Google Workspace 的安全告警,对应 Alert Center API 的 v1beta1 版本。它适合需要以脚本或终端方式处理 Workspace 安全告警的管理员与开发人员。
前置条件
使用前需要先阅读 ../gws-shared/SKILL.md,了解认证方式、全局标志(global flags)以及安全规则。如果该文件缺失,可运行 gws generate-skills 命令生成。
命令形式
基本调用形式为:
gws alertcenter <resource> <method> [flags]
主要能力
该技能覆盖的 API 资源与对应方法如下:
alerts(告警相关操作):
- batchDelete:对告警执行批量删除操作。
- batchUndelete:对告警执行批量恢复操作。
- delete:将指定告警标记为删除。被标记删除的告警会在 30 天后从 Alert Center 中移除。对已被标记删除的告警再次标记删除不会产生效果。尝试标记一个不存在的告警为删除会返回 NOT_FOUND 错误。
- get:获取指定告警。尝试获取不存在的告警会返回 NOT_FOUND 错误。
- getMetadata:返回告警的元数据。尝试获取不存在告警的元数据会返回 NOT_FOUND 错误。
- list:列出告警。
- undelete:恢复(即“取消删除”)在过去 30 天内被标记删除的告警。尝试恢复超过 30 天前被标记删除的告警(已从 Alert Center 数据库中移除)或不存在的告警,会返回 NOT_FOUND 错误。尝试恢复一个未被标记删除的告警不会产生效果。
feedback:针对 feedback 资源的操作(资料中未提供具体方法说明)。
settings(v1beta1 客户级设置):
- getSettings:返回客户级别的设置。
- updateSettings:更新客户级别的设置。
使用方式
在调用任何 API 方法之前,应先检查该方法:
浏览资源与方法: gws alertcenter --help
查看某个方法的必填参数、类型与默认值: gws schema alertcenter.<resource>.<method>
根据 gws schema 的输出构建你的 --params 和 --json 标志。
适用场景
适用于需要以命令行或脚本方式管理 Google Workspace 安全告警的场景,例如列出、获取、批量删除、批量恢复、删除或恢复告警,以及读取和更新客户级别设置。
限制与未提供信息
资料未提供具体的认证细节、全局标志清单、安全规则内容、各方法所需的参数与类型明细、计费或价格信息,也未提供 feedback 资源下的方法说明。这些内容需要参照 gws-shared/SKILL.md 或通过 gws schema、gws alertcenter --help 命令自行查询。