mongocli cloud-manager alerts settings update

在本页

语法

参数
选项
继承选项
输出
示例

修改项目指定警报配置的详细信息。

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

语法

命令语法

mongocli cloud-manager alerts settings update <alertConfigId> [options]

参数

名称	类型	必需	描述
alertConfigId	字符串	true	您要更新的警报配置的唯一标识符。

选项

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

继承选项

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

输出

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

Alert configuration '<ID>' updated.

示例

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

列表

未确认