Docs 菜单

Docs 主页 → MongoDB Ops Manager

确认一个警报

在此页面上

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

注意

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

资源

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

PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}

请求路径参数

范围
类型
必要性
说明
PROJECT-ID
字符串
必需
设置此警报的项目的唯一标识符。
ALERT-ID
字符串
必需
警报的唯一标识符。

请求查询参数

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

名称
类型
必要性
说明
默认
pretty
布尔
Optional
指示响应正文是否应采用 美观文本 的标志 格式。
false
envelope
布尔
Optional

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

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

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

名称
说明
状态
HTTP 响应代码
envelope
预期响应正文
false

请求正文参数

字段
类型
必要性
说明
acknowledged
Until
字符串
可选的

ISO8601 格式的时间戳 应确认警报的日期和时间格式（ UTC 格式）。

  • 要“永远”确认警报，请将该字段值设置为未来的大量年数。 建议设置为 100 年后。

  • 要取消确认已确认的警报，请从请求中删除此参数。

acknowledgement
Comment
字符串
Optional

此确认原因的文本描述。

Ops Manager 在警报已确认的消息旁边显示注释。

响应

返回文档中的字段取决于警报类型：

名称
类型
说明
acknowledged
Until
字符串

ISO8601 格式的时间戳 确认警报之前的日期和时间格式（ UTC ）。

如果警报已被确认，Ops Manager 会返回此值。

acknowledgement
Comment
字符串

确认警报的用户留下的评论。

如果警报已被确认，Ops Manager 会返回此值。

acknowledging
Username
字符串

确认警报的用户的用户名。

如果警报已被确认，Ops Manager 会返回此值。

alertConfigId
字符串
触发此警报的警报配置的唯一标识符。
clusterId
字符串

此警报适用的集群的唯一标识符。

在以下情况下，Ops Manager 返回该值： "eventTypeName" : "SHARDED_CLUSTER"

clusterName
字符串

此警报适用的集群的名称。

在以下情况下，Ops Manager 返回该值： "eventTypeName" : "SHARDED_CLUSTER"

created
字符串
ISO 格式的时间戳8601 打开警报时的日期和时间格式（ UTC 格式）。
currentValue
对象

触发警报的指标的当前值。

如果"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"，Ops Manager 返回此值。

currentValue
.number
数字
指标的值。
currentValue
.units
字符串

值的单位。 值取决于指标类型。

例子

测量内存消耗的指标将采用字节测量值，而测量时间的指标将采用时间单位。

Ops Manager 可能会返回：

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName
字符串

触发警报的事件的名称。

接受的值为：

助手

自动化配置

备份- BAD_CLUSTERSHOTS - CLUSTER_BLACKLIST_UPDATED_AUDIT - CLUSTER_CHECKKPOINT_UPDATED_AUDIT - CLUSTER_CREDENTIAL_UPDATED_AUDIT - CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT - CLUSTER_STATE_CHANGED_AUDIT - CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT - CLUSTERSHOT_DELETED_AUDIT - CLUSTERSHOT_EXPIRY_UPDATED_AUDIT - CONSISTENT_BACKUP_CONFIGURATION - GOOD_CLUSTERSHOT - INCONSISTENT_BACKUP_CONFIGURATION - INITIAL_SYNC_FINISHED_AUDIT - INITIAL_SYNC_STARTED_AUDIT - OPLOG_BEHIND - OPLOG_CURRENT - RESTORE_REQUESTED_AUDIT - RESYNC_PERFORMED - RESYNC_REQUIRED - RS_BLACKLIST_UPDATED_AUDIT - RS_CREDENTIAL_UPDATED_AUDIT - RS_ROTATE_MASTER_KEY_AUDIT - RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT - RS_STATE_CHANGED_AUDIT - RS_STORAGE_ENGINE_UPDATED_AUDIT - SNAPSHOT_DELETED_AUDIT - SNAPSHOT_EXPIRY_UPDATED_AUDIT - SYNC_PENDING_AUDIT - SYNC_REQUIRED_AUDIT

BI Connector

集群

已访问数据浏览器

主机

组织

项目

副本集(Replica Set)

队

user

有关 Ops Manager 审核日志中包含的事件的完整列表，请参阅Audit 事件。

groupId
字符串
为其打开此警报的群组的唯一标识符。
hostId
字符串

指标所属主机的唯一标识符。

如果"eventTypeName"设置为以下值之一，则 Ops Manager 会返回此值：

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

hostnameAndPort
字符串

警报适用的每个主机的主机名和端口。 这可以是主机名、 FQDN 、 IPv4地址或IPv6地址。

如果"eventTypeName"设置为以下值之一，则 Ops Manager 会返回此值：

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

id
字符串
警报的唯一标识符。
lastNotified
字符串
ISO8601 格式的时间戳 上次为此警报发送通知的日期和时间格式（ UTC 格式）。如果已发送通知，Ops Manager 将返回此值。
links
对象数组

指向子资源和/或相关资源的一个或多个链接。响应中的所有links 数组至少包含一个名为self 的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

metricName
字符串

Go阈值的测量名称。

如果"eventTypeName"设置为OUTSIDE_METRIC_THRESHOLD，Ops Manager会返回此值。

有关可能的值，请参阅警报的测量类型。

replicaSetName
字符串

副本集名称。

如果"eventTypeName"设置为以下值之一，则 Ops Manager 会返回此值：

  • BACKUP

  • HOST_DOWN

  • OUTSIDE_METRIC_THRESHOLD

  • REPLICA_SET

resolved
字符串

ISO8601 格式的时间戳 警报关闭时的日期和时间格式（ UTC 格式）。

如果"status" : "CLOSED"，Ops Manager 返回此值。

status
字符串

警报的当前状态。 Ops Manager 可以返回以下之一：

  • TRACKING

    警报条件存在，但持续时间尚未超过定义的通知延迟。 有关详细信息，请参阅请求查询参数。

  • OPEN

  • CLOSED

  • CANCELLED

sourceTypeName
字符串

"eventTypeName" : "BACKUP"时正在备份的主机的类型。 Ops Manager 可以返回以下之一：

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

tags
字符串数组
正在为此警报设置标识标签。
typeName
字符串
已弃用字段。|彩信|忽略它。
updated
字符串
ISO8601 格式的时间戳 上次更新警报时的日期和时间格式（ 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://<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       }'

响应示例

响应标头

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}

响应体

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}
← 获取一个警报
警报配置 →

在此页面上