确认一个警报
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
Resource
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}
请求路径参数
Parameter | 类型 | 必要性 | 说明 |
---|---|---|---|
PROJECT-ID | 字符串 | 必需 | 设置此警报的项目的唯一标识符。 |
ALERT-ID | 字符串 | 必需 | 警报的唯一标识符。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
字段 | 类型 | 必要性 | 说明 |
---|---|---|---|
acknowledged Until | 字符串 | 可选的 | ISO8601 格式的时间戳 应确认警报的日期和时间格式( UTC 格式)。
|
acknowledgement Comment | 字符串 | Optional | 此确认原因的文本描述。 Ops Manager 在警报已确认的消息旁边显示注释。 |
响应
返回文档中的字段取决于警报类型:
名称 | 类型 | 说明 |
---|---|---|
acknowledged Until | 字符串 | ISO8601 格式的时间戳 确认警报之前的日期和时间格式( UTC )。 如果警报已被确认,Ops Manager 会返回此值。 |
acknowledgement Comment | 字符串 | 确认警报的用户留下的评论。 如果警报已被确认,Ops Manager 会返回此值。 |
acknowledging Username | 字符串 | 确认警报的用户的用户名。 如果警报已被确认,Ops Manager 会返回此值。 |
alertConfigId | 字符串 | 触发此警报的警报配置的唯一标识符。 |
clusterId | 字符串 | 此警报适用的集群的唯一标识符。 在以下情况下,Ops Manager 返回该值:
|
clusterName | 字符串 | 此警报适用的集群的名称。 在以下情况下,Ops Manager 返回该值:
|
created | 字符串 | ISO 格式的时间戳8601 打开警报时的日期和时间格式( UTC 格式)。 |
currentValue | 对象 | 触发警报的指标的当前值。 如果 |
currentValue .number | 数字 | 指标的值。 |
currentValue .units | 字符串 | 值的单位。 值取决于指标类型。 示例,测量内存消耗的指标将具有字节测量值,而测量时间的指标将具有时间单位。 Ops Manager 可能会返回:
|
eventTypeName | 字符串 | 触发警报的事件的名称。 接受的值为: 助手 自动化配置 备份- BI Connector 集群 已访问数据浏览器 主机 组织 项目 副本集(Replica Set) 团队 user 有关 Ops Manager 审核日志中包含的事件的完整列表,请参阅Audit 事件。 |
groupId | 字符串 | 为其打开此警报的群组的唯一标识符。 |
hostId | 字符串 | 指标所属主机的唯一标识符。 如果
|
hostnameAndPort | 字符串 | 警报适用的每个主机的主机名和端口。 这可以是主机名、 FQDN 、 IPv4地址或IPv6地址。 如果
|
id | 字符串 | 警报的唯一标识符。 |
lastNotified | 字符串 | ISO8601 格式的时间戳 上次为此警报发送通知的日期和时间格式( UTC 格式)。如果已发送通知, MongoDB Ops Manager将返回此值。 |
links | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
metricName | 字符串 | |
replicaSetName | 字符串 | 副本集名称。 如果
|
resolved | 字符串 | ISO8601 格式的时间戳 警报关闭时的日期和时间格式( UTC 格式)。 如果 |
status | 字符串 | 警报的当前状态。 Ops Manager 可以返回以下之一:
|
sourceTypeName | 字符串 |
|
tags | 字符串数组 | 正在为此警报设置标识标签。 |
updated | 字符串 | ISO8601 格式的时间戳 上次更新警报时的日期和时间格式( UTC 格式)。 |
请求示例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PATCH "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}" 6 --data ' 7 { 8 "acknowledgedUntil": "2016-04-15T00:00:00-0400", 9 "acknowledgementComment": "This is normal. Please ignore." 10 }'
响应示例
响应标头
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
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}
响应体
1 { 2 "id" : "{ALERT-CONFIG-ID}", 3 "groupId" : "{PROJECT-ID}", 4 "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", 5 "status" : "OPEN", 6 "acknowledgedUntil" : "2014-04-15T04:00:00Z", 7 "acknowledgementComment" : "This is normal. Please ignore.", 8 "acknowledgingUsername" : "someuser@example.com", 9 "created" : "2014-04-03T20:28:14Z", 10 "updated" : "2014-04-03T20:33:14Z", 11 "lastNotified" : "2014-04-03T20:33:23Z", 12 "metricName": "ASSERTS_REGULAR", 13 "currentValue" : { 14 "number" : 0.0, 15 "units" : "RAW" 16 }, 17 "links" : [] 18 }