MongoDB工具 >MongoDB命令行界面 >参考 >云端经理 > 列出警报配置
该命令检索在指定的Cloud Manager项目中配置的所有警报。您还可以通过Cloud Manager API检索项目中配置的所有警报。alerts configs list
选项 | 类型 | 描述 | 需要? |
---|---|---|---|
--profile , -P |
串 | 保存项目的公钥和私钥的概要文件的名称。如果省略,则使用default
配置文件。要了解有关创建配置文件的更多信息,请参阅配置MongoDB CLI。 |
没有 |
--projectId |
串 | 项目的唯一标识符,包含要检索的警报配置。 注意 您可以使用以下命令检索项目列表,包括其ID 。 |
没有 |
--page |
整数 | 页码(从1开始)。1 如果未指定,则默认为。 |
没有 |
--limit |
整数 | 每页要返回的项目数,最多为500。100 如果未指定,则默认为。 |
没有 |
如果命令成功执行,则它将以下字段的子集以JSON格式输出到终端,以描述每个警报配置。如果命令返回错误,请参阅故障排除以获取推荐的解决方案。
名称 | 类型 | 描述 |
---|---|---|
被创造 | 串 | 创建此警报配置时,采用UTC的ISO 8601日期和时间格式的时间戳。 |
已启用 | 布尔值 | 指示已启用此警报配置的标志。 |
eventTypeName | 串 | 触发警报的事件类型。 有关警报事件的完整列表,请参阅警报条件。 |
groupId | 串 | 拥有此警报配置的项目的唯一标识符。 |
ID | 串 | 此警报配置的唯一标识符。 |
matchers.fieldName | 串 | 要匹配的目标对象中字段的名称。 使用列表警报配置匹配器字段可返回可能的值。 |
Matchers.operator | 串 | 操作员测试该字段的值。可接受的值为:
|
matchers.value | 串 | 用指定的运算符测试的值。 如果
|
配对者 | 对象数组 | 将对象与此警报配置匹配时要应用的规则。仅检查符合所有这些规则的实体的警报条件。
|
metricThreshold.metricName | 串 | 值超出阈值的度量标准名称。仅适用于采用
|
metricThreshold.mode | 串 | 该指标的平均值。 |
metricThreshold.operator | 串 | 操作员在对照阈值检查当前度量值时应用。可接受的值为:
|
metricThreshold.threshold | 数 | 超出阈值的警报将被触发。 |
metricThreshold.units | 串 | 阈值的单位。取决于指标的类型。 例 测量内存消耗的度量标准将具有字节度量,而测量时间的度量标准将具有时间单位。 可接受的值为:
|
metricThreshold | 宾语 | 将导致触发警报的阈值。如果填充。"eventTypeName" :
"OUTSIDE_METRIC_THRESHOLD" |
notifications.apiToken | 串 | Slack API令牌或Bot令牌。填充SLACK
通知。如果令牌稍后变得无效,则Cloud Manager会向项目所有者发送电子邮件,并最终删除令牌。 |
notifications.channelName | 串 | 松弛的频道名称。填充SLACK 通知。 |
notifications.delayMin | 数 | 在检测到警报条件之后,发出第一条通知之前要等待的分钟数。 |
notifications.emailAddress | 串 | 向其发送通知的电子邮件地址。填充
EMAIL 通知。 |
notifications.emailEnabled | 布尔值 | 指示必须发送电子邮件通知的标志。为填充ORG ,GROUP 和USER 通知。 |
notifications.flowdockApiToken | 串 | Flowdock“个人API令牌”。填充
FLOWDOCK 通知。如果令牌稍后变得无效,则Cloud Manager会向项目所有者发送电子邮件,并最终删除令牌。 |
notifications.flowName | 串 | 流名称,以小写字母表示。填充
FLOWDOCK 通知。流名称显示在URL字符串中的组织名称之后
www.flowdock.com/app/<organization-name>/<flow-name> 。 |
notifications.intervalMin | 数 | 在连续的通知之间等待未解决的未确认警报的等待分钟数。 |
notifications.orgName | 串 | Flowdock组织名称以小写字母表示。这是www.flowdock.com/app/ URL字符串后出现的名称。填充FLOWDOCK 通知。 |
notifications.role | 串 | 当前项目中的Cloud Manager角色。填充GROUP
通知。 |
notifications.serviceKey | 串 | PagerDuty服务密钥。填充PAGER_DUTY
通知。如果密钥稍后变得无效,则Cloud Manager会向项目所有者发送电子邮件,并最终删除密钥。 |
notifications.smsEnabled | 布尔值 | 指示必须发送SMS通知的标志。为填充ORG ,GROUP 和USER 通知。 |
notifications.typeName | 串 | 警报通知的类型。可接受的值为:
|
notifications.username | 串 | 向其发送通知的Cloud Manager用户的名称。此处仅允许项目中拥有警报配置的用户。填充USER 通知。 |
通知 | 对象数组 | 检测到警报条件时发送的通知。 |
阈值运算符 | 串 | 操作员在对照阈值检查当前度量值时应用。
|
阈值 | 数 | 超出阈值的警报将被触发。 |
阈 | 宾语 | 将导致触发警报的阈值。如果填充
|
typeName | 串 | 此字段已弃用,将被忽略。 |
更新 | 串 | 上次更新此警报配置时采用UTC的ISO 8601日期和时间格式的时间戳。 |