mongocli ops-manager alerts settings create

本页面内容

语法

选项
继承选项
输出
示例

为您的项目创建警报配置。

要使用此命令，您必须使用具有项目所有者角色的用户帐户或API密钥进行身份验证。

语法

命令语法

mongocli ops-manager alerts settings create [options]

选项

名称	类型	必需	描述
--apiKey	字符串	否	Datadog API密钥、Opsgenie API密钥或VictorOps API密钥。如果通知类型分别为DATADOG、OPS_GENIE或VICTOR_OPS，则必需。
--enabled		否	标志，指示是否启用警报配置。
--event	字符串	否	触发警报的事件类型。有关CLI接受的值，请参阅Atlas API文档中可能的eventTypeName值（https://dochub.mongodb.org/core/atlas-event-names）、Ops Manager（《https://dochub.mongodb.org/core/om-event-names》），或 Cloud Manager（《https://dochub.mongodb.org/core/cm-event-names》）。
-h, --help		否	create 命令的帮助信息
--matcherFieldName	字符串	否	目标对象中用于匹配的字段名称。要了解有效的值，请运行 mongocli atlas alerts settings fields 命令。
--matcherOperator	字符串	否	在检查当前指标与 matcherValue 的比较时应用的比较运算符。有效的值是 CONTAINS、ENDS_WITH、EQUALS、NOT_CONTAINS、NOT_EQUALS、REGEX、STARTS_WITH。
--matcherValue	字符串	否	与指定的运算符一起测试的值。如果 matcherFieldName 设置为 TYPE_NAME，可以匹配以下值：CONFIG、MONGOS、PRIMARY、SECONDARY、STANDALONE。
--metricMode	字符串	否	指示 Atlas 是否将当前指标值计算为平均值的选项。有效的值是 AVERAGE。
--metricName	字符串	否	此命令检查配置警报的指标名称。要了解有效值，请参阅https://dochub.mongodb.org/core/alert-host-metrics-atlas。此选项仅适用于事件设置为 OUTSIDE_METRIC_THRESHOLD。
--metricOperator	字符串	否	检查当前指标值时应用的比较运算符。有效值是 LESS_THAN 和 GREATER_THAN。
--metricThreshold	float	否	触发警报的阈值值。
--metricUnits	字符串	否	阈值值的单位。有效值是 BITS、BYTES、DAYS、GIGABITS、GIGABYTES、HOURS、KILOBITS、KILOBYTES、MEGABITS、MEGABYTES、MILLISECONDS、MINUTES、PETABYTES、RAW、SECONDS、TERABYTES。
--notificationChannelName	字符串	否	Slack频道名称。对于SLACK通知类型是必需的。
--notificationDelayMin	int	否	在检测到警报条件后等待多少分钟才发送第一条通知。
--notificationEmailAddress	字符串	否	发送警报通知的电子邮件地址。
--notificationEmailEnabled		否	启用电子邮件通知的标志。可配置为 GROUP 和 USER 通知类型。
--notificationIntervalMin	int	否	等待分钟数，用于发送未解决且未确认的后续通知。
--notificationMobileNumber	字符串	否	发送警报通知的移动电话号码。
--notificationRegion	字符串	否	指示要使用哪个 API URL 的区域。
--notificationServiceKey	字符串	否	PagerDuty服务密钥。
--notificationSmsEnabled		否	启用短信通知的标志。
--notificationTeamId	字符串	否	团队的唯一标识符。
--notificationToken	字符串	否	Slack API令牌或Bot令牌。
--notificationType	字符串	否	警报通知类型。有效值是 DATADOG、EMAIL、GROUP（项目）、ORG、OPS_GENIE、PAGER_DUTY、SLACK、SMS、USER 或 VICTOR_OPS。
--notificationUsername	字符串	否	要发送通知的Atlas用户名称。
--notificationVictorOpsRoutingKey	字符串	否	与您的Splunk On-Call账户关联的路由键。
-o, --output	字符串	否	输出格式。有效值是 json、json-path、go-template 或 go-template-file。要查看完整输出，请使用 -o json 选项。
--projectId	字符串	否	用于标识项目的十六进制字符串。此选项覆盖配置文件或环境变量中的设置。

继承选项

名称	类型	必需	描述
-P, --profile	字符串	否	使用配置文件中的配置文件名称。有关MongoCLI的配置文件信息，请参阅https://dochub.mongodb.org/core/atlas-cli-configuration-file.

输出

如果命令执行成功，CLI将返回类似于以下示例的输出。括号内的值代表您的值。

Alert configuration <ID> created.

示例

# Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305:
mongocli [ops-manager|cloud-manager] alerts settings create --event JOINED_GROUP --enabled \
--notificationType USER --notificationEmailEnabled \
--notificationUsername john@example.com \
--output json --projectId 5df90590f10fab5e33de2305

设置

删除