MongoDB工具 >MongoDB命令行界面 >参考 >阿特拉斯 > 列出警报配置
该命令将检索在指定的Atlas项目中配置的所有警报。alerts configs list
选项 | 类型 | 描述 | 需要? |
---|---|---|---|
--profile , -P |
串 | 保存项目的公钥和私钥的概要文件的名称。如果省略,则使用default
配置文件。要了解有关创建配置文件的更多信息,请参阅配置MongoDB CLI。 |
没有 |
--projectId |
串 | 包含要更新的集群的项目的唯一标识符。 | 没有 |
--page |
整数 | 页码(从1开始)。1 如果未指定,则默认为。 |
没有 |
--limit |
整数 | 每页要返回的项目数,最多为500。100 如果未指定,则默认为。 |
没有 |
如果命令成功执行,则它将以下字段的子集以JSON格式输出到终端,以描述每个警报配置。如果命令返回错误,请参阅故障排除以获取推荐的解决方案。
名称 | 类型 | 描述 |
---|---|---|
id |
串 | 警报配置的唯一标识符。 |
groupId |
串 | 拥有此警报配置的项目的唯一标识符。 |
eventTypeName |
串 | 触发警报的事件类型。 有关警报事件的完整列表,请参阅警报条件。 |
created |
串 | 创建此警报配置时,采用UTC的ISO 8601日期和时间格式的时间戳。 |
updated |
串 | 上次更新此警报配置时采用UTC的ISO 8601日期和时间格式的时间戳。 |
enabled |
布尔值 | 如果设置为 如果 |
matchers |
对象数组 | 将对象与此警报配置匹配时要应用的规则。仅检查符合所有这些规则的实体的警报条件。
|
matchers .fieldName |
串 | 要匹配的目标对象中字段的名称。
所有其他类型的警报均不支持匹配器。 |
matchers .operator |
串 | 操作员测试该字段的值。可接受的值为:
|
matchers .value |
串 | 用指定的运算符测试的值。 如果为,则可以匹配以下值:
|
metricThreshold |
宾语 | 触发警报的阈值。如果填充。"eventTypeName" :
"OUTSIDE_METRIC_THRESHOLD" |
metricThreshold .metricName |
串 | 值超出阈值的度量标准名称。仅适用于采用
|
metricThreshold .operator |
串 | 操作员在对照阈值检查当前度量值时应用。可接受的值为:
|
metricThreshold .threshold |
整数 | 阈值,超出此阈值将触发警报。 |
metricThreshold .units |
串 | 阈值的单位。取决于指标的类型。 例 测量内存消耗的度量标准将具有字节度量,而测量时间的度量标准将具有时间单位。 可接受的值为:
|
metricThreshold .mode |
串 | AVERAGE 。Atlas将当前度量标准值计算为平均值。 |
notifications |
对象数组 | 检测到警报条件时发送的通知。 |
notifications .typeName |
串 | 警报通知的类型。可接受的值为:
|
notifications .intervalMin |
整数 | 在连续的通知之间等待未解决的未确认警报的等待分钟数。 |
notifications .delayMin |
整数 | 在检测到警报条件之后,发出第一条通知之前要等待的分钟数。 |
notifications .emailEnabled |
布尔值 | 指示是否应发送电子邮件通知的标志。以ORG ,GROUP 和USER 通知类型返回。 |
notifications .smsEnabled |
布尔值 | 指示是否应发送短信通知的标志。以ORG ,GROUP 和USER 通知类型返回。 |
notifications .username |
串 | 向其发送通知的Atlas用户的名称。此处仅允许项目中拥有警报配置的用户。返回USER 通知类型。 |
notifications .roles |
字符串数组 | 接收配置的警报的一个或多个项目角色。可接受的值包括:
|
notifications .teamId |
串 | 团队的唯一标识符。 |
notifications .emailAddress |
串 | 警报通知发送到的电子邮件地址。返回EMAIL 通知类型。 |
notifications .mobileNumber |
串 | 发送警报通知的手机号码。返回SMS 通知类型。 |
notifications .channelName |
串 | 松弛的频道名称。返回SLACK 通知类型。 |
notifications .apiToken |
串 | Slack API令牌或Bot令牌。返回SLACK 通知类型。如果令牌稍后变得无效,则Atlas向项目所有者发送电子邮件,并最终删除该令牌。 |
notifications .orgName |
串 | Flowdock组织名称以小写字母表示。这是www.flowdock.com/app/ URL字符串后出现的名称。返回FLOWDOCK 通知类型。 |
notifications .flowName |
串 | Flowdock流名称以小写字母表示。流名称显示在URL字符串中的组织名称之后:
返回 |
notifications .flowdockApiToken |
串 | Flowdock个人API令牌。返回
FLOWDOCK 通知类型。如果令牌稍后变得无效,则Atlas向项目所有者发送电子邮件,并最终删除该令牌。 |
notifications .serviceKey |
串 | PagerDuty服务密钥。返回PAGER_DUTY
通知类型。如果密钥以后变得无效,Atlas将电子邮件发送给项目所有者,并最终将其删除。 |
notifications .victorOpsApiKey |
串 | VictorOps API密钥。返回VICTOR_OPS 通知类型。如果密钥以后变得无效,Atlas将电子邮件发送给项目所有者,并最终将其删除。 |
notifications .victorOpsRoutingKey |
串 | VictorOps路由密钥。返回VICTOR_OPS 通知类型。如果密钥以后变得无效,Atlas将电子邮件发送给项目所有者,并最终将其删除。 |
notifications .opsGenieApiKey |
串 | Opsgenie API密钥。返回OPS_GENIE
通知类型。如果密钥以后变得无效,Atlas将电子邮件发送给项目所有者,并最终删除令牌。 |
notifications .opsGenieRegion |
串 | 指示要使用的API URL的区域。可接受的区域是:
默认的Opsgenie区域为 |
notifications .datadogApiKey |
串 | Datadog API密钥。在Datadog仪表板中找到。为DATADOG 通知类型填充。 |
notifications .datadogRegion |
串 | 指示要使用的API URL的区域。可接受的区域是:
默认的Datadog区域为 |