Atlas 警报设置列表
返回项目的所有警报配置。
要使用此命令,您必须使用具有“项目只读”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas alerts settings list [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-c, --compact | false | 为 json 输出启用紧凑数组响应结构的标志。 --compact 选项返回数组对象作为顶层响应,并允许基于以前 CLI 版本的脚本向后兼容。 省略 JSON 输出的 --compact 选项会在“结果”子数组中返回数组对象。 必须指定 --output json 才能使用此选项。 | |
-h,--help | false | 列表帮助 | |
--limit | int | false | 每个结果页面的列项数,最多 500 个。 如果结果超过 500 个,请指定 --page 选项以更改结果页面。 此值默认为 100。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--page | int | false | 指定结果页面的页码。 该值默认为 1。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
# Return a JSON-formatted list of all alert configurations for the project with the ID 5df90590f10fab5e33de2305: atlas alerts settings list --projectId 5df90590f10fab5e33de2305 --output json