启用/禁用警报配置

在此页面上

Resource

请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

基本URL：云1.0

Resource

PATCH /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}

注意

此端点仅更新警报配置的启用/禁用状态。要更新的不仅仅是此配置，请参阅更新警报配置。

请求路径参数

所有请求路径参数均为必填项。

Parameter	类型	说明
PROJECT-ID	字符串	此项目的唯一标识符。
ALERT-CONFIG-ID	字符串	此警报配置的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用美观打印的标志格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

所有请求正文参数均为必填项。

Parameter	类型	说明
enabled	布尔	指定`true`以启用； `false`以禁用。

响应

注意

警报配置各不相同。警报配置可能仅包含这些元素的子集。

名称	类型	说明
已创建	字符串	ISO8601 格式的时间戳创建此警报配置时的日期和时间格式（ UTC 格式）。
enabled	布尔	指示此警报配置已启用的标志。
eventTypeName	字符串	触发警报的事件类型。
groupId	字符串	拥有此警报配置的项目的唯一标识符。
id	字符串	警报配置的唯一标识符。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。 URL 之间的关系类型在 Web 链接规范中进行了解释。
matchers	对象数组	将对象与此警报配置进行匹配时要应用的规则。
matchers .[n].fieldName	字符串	您希望此配置匹配的目标对象中的字段名称。
matchers .[n].operator	字符串	根据`matcher.[n].value`检查当前指标值时要应用的比较操作符。
matchers .[n].value	字符串	使用`matchers.[n].operator`时要匹配或超过的值。
metricThreshold	对象	Atlas Triggers警报的值和比较方法。
metricThreshold .metricName	字符串	要检查的指标名称。支持与`alerts`资源的`metricName`字段相同的值。
metricThreshold .mode	字符串	此指标的平均值。
metricThreshold .operator	字符串	Cloud Manager 在根据阈值检查当前指标值时应用的比较操作符。
metricThreshold .threshold	数字	`metricThreshold.metricName`的值，超过该值时会Atlas Triggers警报。
metricThreshold .units	字符串	定义`metricThreshold.threshold`范围的容量或时间单位。
通知	对象数组	Cloud Manager 在检测到警报条件时发送通知的一个或多个目标。
notifications.[n] .apiToken	字符串	Slack API 令牌令牌。如果您将`notifications.[n].typeName`设置为`SLACK`，Cloud Manager会返回此值。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
notifications.[n] .channelName	字符串	Slack 渠道名称。如果您将`notifications.[n].typeName`设置为`SLACK`，Cloud Manager会返回此值。
notifications.[n] .datadogApiKey	字符串	DataDog API 密钥。如果您将`notifications.[n].typeName`设置为`DATADOG`，Cloud Manager会返回此值。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
notifications.[n] .delayMin	数字	检测到警报条件后发送第一个通知之前的等待分钟数。
notifications.[n] .emailAddress	字符串	向其发送通知的电子邮件地址。如果您将`notifications.[n].typeName`设置为`EMAIL`，Cloud Manager会返回此值。
notifications.[n] .emailEnabled	布尔	指示必须发送电子邮件通知的标志。如果将`notifications.[n].typeName`设置为`ORG` 、 `GROUP`或`USER` ，Cloud Manager 会返回此值。
notifications.[n] .intervalMin	数字	未解决的未确认警报的连续通知之间等待的分钟数。
notifications.[n] .microsoftTeamsWebhookUrl	字符串	Microsoft Teams 通道传入的 Webhook URL。如果您将`notifications.[n].typeName`设置为`MICROSOFT_TEAMS`，Cloud Manager会返回此值。当您查看或编辑 Webhook 通知的警报时，URL 会显示为部分遮蔽，而密钥显示为完全遮蔽。
notifications.[n] .mobileNumber	字符串	向其发送警报通知的手机号码。如果您将`notifications.[n].typeName`设置为`SMS`，Cloud Manager会返回此值。
notifications.[n] .notificationToken	字符串	HipChat API 令牌。如果您将`notifications.[n].typeName`设置为`HIP_CHAT`，Cloud Manager会返回此值。如果令牌后来变得无效，MongoDB Atlas 会向`Project Owner`发送电子邮件，并最终删除令牌。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
notifications.[n] .opsGenieApiKey	字符串	OpsGenie 警报 API 键。如果将`notifications.[n].typeName`设置为`OPS_GENIE` ，Cloud Manager 会返回此值。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
notifications.[n] .opsGenieRegion	字符串	地区指示要使用的API URL。如果将`notifications.[n].typeName`设置为`OPS_GENIE`，Cloud Manager会返回此值。
notifications.[n] .roles	字符串数组	当前项目或组织中的 Cloud Manager 角色。如果您将`notifications.[n].typeName`设置为`ORG`或`GROUP`，Cloud Manager会返回此值。
notifications.[n] .roomName	字符串	HipChat 房间名称。 Cloud Manager 在`"notifications.typeName" : "HIP_CHAT`的情况下返回此值。
notifications.[n] .serviceKey	字符串	PagerDuty 服务密钥。如果您将`notifications.[n].typeName`设置为`PAGER_DUTY`，Cloud Manager会返回此值。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
notifications.[n] .smsEnabled	布尔	指示必须发送文本通知的标志。如果将`notifications.[n].typeName`设置为`ORG` 、 `GROUP`或`USER` ，Cloud Manager 会返回此值。
notifications.[n] .teamId	字符串	接收此通知的团队的唯一标识符。
notifications.[n] .teamName	字符串	接收此通知的团队的标签。
notifications.[n] .typeName	字符串	您希望 Cloud Manager 向您发送警报通知的方式。
notifications.[n] .username	字符串	向其发送通知的 Cloud Manager 用户的名称。如果您将`notifications.[n].typeName`设置为`USER`，Cloud Manager会返回此值。
notifications.[n] .victorOpsApiKey	字符串	VictorOps API密钥。如果密钥后来变得无效，MongoDB Atlas 会向`Project Owner`发送电子邮件并最终删除密钥。如果您将`notifications.[n].typeName`设置为`VICTOR_OPS` ，Cloud Manager 会返回此值。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
notifications.[n] .victorOpsRoutingKey	字符串	VictorOps 路由键。如果密钥后来变得无效，MongoDB Atlas 会向`Project Owner`发送电子邮件并最终删除密钥。如果您将`notifications.[n].typeName`设置为`VICTOR_OPS` ，Cloud Manager 会返回此值。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
notifications.[n] .webhookSecret	字符串	用于向接受和转发通知的 Webhook 进行身份验证的值。如果您将`notifications.[n].typeName`设置为`WEBHOOK` ，并且满足以下任一条件，Cloud Manager 会返回此值：您将`notification.[n].webhookSecret`设置为非空字符串您可以在“集成”页面上设置默认`webhookSecret` ，或者使用集成 API 创建 Webhook 通知后，当您查看或编辑警报时， URL将被部分编辑，并且密钥将被完全编辑。
notifications.[n] .webhookUrl	字符串	Atlas Triggers此通知的 Webhook 的URL 。如果您将`notifications.[n].typeName`设置为`WEBHOOK` ，并且满足以下任一条件，Cloud Manager 会返回此值：您将`notification.[n].webhookURL`设置为非空字符串您可以在“集成”页面上设置默认`webhookUrl` ，或者使用集成 API 创建 Webhook 通知后，当您查看或编辑警报时， URL将被部分编辑，并且密钥将被完全编辑。
阈值	对象	Atlas Triggers警报的阈值。如果`eventTypeName`是`OUTSIDE_METRIC_THRESHOLD`以外的任何值，Cloud Manager 会返回此值。
threshold .operator	字符串	Cloud Manager 在根据阈值检查当前指标值时应用的比较操作符。
threshold .threshold	数字	超过该值时，Cloud Manager 会Atlas Triggers警报。
threshold .units	字符串	定义`threshold.threshold`范围的容量或时间单位。
typeName	字符串	此字段已弃用并被忽略。
Updated	字符串	ISO8601 格式的时间戳上次更新此警报配置时的日期和时间格式（ UTC 格式）。

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Content-Type: application/json' \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}" \
     --data '
       {
         "enabled" : false
       }'

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{
  "created" : "2014-04-23T14:52:29Z",
  "enabled" : false,
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "links" : [],
  "matchers" : [ {
    "fieldName" : "REPLICA_SET_NAME",
    "operator" : "EQUALS",
    "value" : "rs1"
  } ],
  "notifications" : [ {
    "delayMin" : 5,
    "emailAddress" : "sos@example.com",
    "intervalMin" : 60,
    "typeName" : "EMAIL"
  }, {
    "delayMin" : 60,
    "emailEnabled" : false,
    "intervalMin" : 120,
    "smsEnabled" : true,
    "typeName" : "GROUP"
  } ],
  "updated" : "2014-04-23T14:52:29Z"
}

后退

更新警报配置

来年

删除警报配置

启用/禁用警报配置.leafygreen-ui-m0pgrr{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.leafygreen-ui-a30zj9{color:#889397;vertical-align:middle;margin-top:-2px;}.css-fmznk8{margin-top:-85px;position:absolute;padding-bottom:2px;}

注意