确认一个全局警报

您可以在指定的时间和日期之前确认一个警报。您还可以通过指定过去的日期和时间来取消确认警报。

所需角色

您可以使用以下任何分配的角色成功调用此端点：

请求

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PATCH /globalAlerts/{ALERT-ID}

请求路径参数

名称	类型	说明
`ALERT-ID`	字符串	要确认的警报的唯一标识符。

请求查询参数

名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示响应正文是否采用 pretty-print 格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。对于返回一个结果的端点，响应体包括： `status`: HTTP 响应代码 `content`：预期响应正文	`false`

请求正文参数

正文参数	类型	必要性	说明
`acknowledgedUntil`	字符串	必需	ISO 8601 日期和时间格式的时间戳（UTC 格式），用于确认此警报。在此时间过后， Ops Manager会将警报恢复为未确认状态。为防止警报很快恢复，请将日期和时间设置为遥远的将来的某个时间点。要取消确认警报，请指定过去的时间和日期。
`acknowledgementComment`	字符串	Optional	描述警报确认的注释。

响应

名称	类型	说明
`acknowledgedUntil`	字符串	时间戳在 ISO 8601 日期和时间格式，使用 UTC 来确认警报。MongoDB Ops Manager 会在用户确认此警报后显示此字段。
`acknowledgementComment`	字符串	确认此警报的用户留下的注释。如果用户确认此警报，Ops Manager 会显示此字段。
`acknowledgingUsername`	字符串	确认警报的用户的 Ops Manager 用户名。如果用户确认此警报，Ops Manager 会显示此字段。
`alertConfigId`	字符串	触发此警报的全局警报配置的唯一标识符。
`clusterId`	字符串	此警报适用的集群的唯一标识符。 Ops Manager 会为以下类别的警报返回此字段：备份复制集分片集群
`clusterName`	字符串	为适用此警报的集群命名。 Ops Manager 会为以下类别的警报返回此字段：备份复制集分片集群
`created`	字符串	时间戳，采用 ISO 8601 日期和时间格式，时区为 UTC，创建警报时。
`currentValue`	对象	触发警报的指标的当前值。 Ops Manager 会为主机类别中的全球警报返回此字段。
`currentValue.number`	数字	指标的当前值。
`currentValue.units`	字符串	`currentValue.number`的单位。单位取决于指标类型。接受的值为： `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS` 示例，测量内存消耗的指标可以使用`BYTES` ，而测量时间的指标则可以使用`HOURS` 。
`eventTypeName`	字符串	触发警报的事件的名称。要查看生成警报的事件类型，请参阅警报类型。有关 Ops Manager 审核日志中包含的事件的完整列表，请参阅Audit 事件。
`groupId`	字符串	为其打开此警报的项目的唯一标识符。
`hostId`	字符串	指标所属主机的唯一标识符。 Ops Manager 会为以下类别的全局警报返回此字段：主机复制集
`hostnameAndPort`	字符串	警报所适用的每个主机的 hostname 和端口。主机名可以是主机名、FQDN、IPv4 地址或 IPv6 地址。MongoDB Ops Manager 会针对以下类别的全局警报返回此字段：主机复制集
`id`	字符串	警报的唯一标识符。
`lastNotified`	字符串	针对此警报上次发送通知时的时间戳，采用 ISO 8601 日期和时间格式（UTC 时间）。MongoDB Ops Manager 会显示此信息，前提是 Ops Manager 已发送了通知。
`metricName`	字符串	Go值超出阈值的测量名称。如果`"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`，Ops Manager 返回此字段。有关可能的值，请参阅全局警报的测量类型。
`replicaSetName`	字符串	副本集的名称。 Ops Manager 会为以下类别的警报返回此字段：主机备份复制集
`resolved`	字符串	关闭警报时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。当 `"status" : "CLOSED"` 时， Ops Manager会返回全局警报的此字段。
`sourceTypeName`	字符串	正在备份的主机类型。 Ops Manager 会为备份类别中的全局警报返回此字段。可能返回的值包括： `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`status`	字符串	警报的当前状态。可能返回的值包括： `TRACKING`: 存在警报条件，但条件尚未持续足够长的时间以 trigger 警报。 `OPEN`: 警报已打开。 `CLOSED`: 警报已关闭。 `CANCELLED`: 警报已取消。
`tags`	字符串数组	与此警报关联的标签。
`typeName`	字符串	此字段已弃用，将被忽略。
`updated`	字符串	上次更新此警报时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。

请求示例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2     --header "Accept: application/json" \3     --header "Content-Type: application/json" \4     --include \5     --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}" \6     --data '{7        "acknowledgedUntil":"2020-04-10T20:21:31Z",8        "acknowledgementComment":"test"9       }'

响应示例

响应标头

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

HTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

1{2  "acknowledgedUntil": "2020-04-10T20:20:38Z",3  "acknowledgementComment": "test",4  "acknowledgingUsername": "rwqvzark",5  "alertConfigId": "{ALERT-CONFIG-ID}",6  "created": "2019-12-02T20:39:54Z",7  "eventTypeName": "BACKUP_AGENT_DOWN",8  "groupId": "{PROJECT-ID}",9  "id": "{ALERT-ID}",10  "lastNotified": "2020-04-09T20:21:31Z",11  "links": [12  ],13  "status": "OPEN",14  "tags": [],15  "typeName": "AGENT",16  "updated": "2020-04-10T19:14:38Z"17}