Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/
API
/
资源
/
测量和警报
/
全局警报

获取一个全局警报

在此页面上

  • 所需角色
  • 请求
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

检索一个以其 ALERT-ID标识的警报。

所需角色

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

  • Global Owner

  • Global Monitoring Admin

请求

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

GET /globalAlerts/{ALERT-ID}

请求路径参数

名称
类型
说明

ALERT-ID

字符串

要检索的警报的唯一标识符。

请求查询参数

名称
类型
必要性
说明
默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志 格式。

false

envelope

布尔

Optional

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

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

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

false

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称
类型
说明

acknowledgedUntil

字符串

ISO8601 格式的时间戳 已确认警报的日期和时间格式（ UTC 格式）。如果用户确认此警报， MongoDB Ops Manager显示此字段。

acknowledgementComment

字符串

确认此警报的用户留下的注释。 如果用户确认此警报，Ops Manager 会显示此字段。

acknowledgingUsername

字符串

确认警报的用户的 Ops Manager 用户名。 如果用户确认此警报，Ops Manager 会显示此字段。

alertConfigId

字符串

触发此警报的全局警报配置的唯一标识符。

clusterId

字符串

此警报适用的集群的唯一标识符。 Ops Manager 会为以下类别的警报返回此字段：

clusterName

字符串

为适用此警报的集群命名。 Ops Manager 会为以下类别的警报返回此字段：

created

字符串

ISO8601 格式的时间戳 创建警报时的日期和时间格式（ 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

字符串

警报适用的每个主机的主机名和端口。 主机名只能是主机名、 FQDN 、 IPv4地址或IPv6地址。 Ops Manager 会为以下类别的警报返回此字段：

id

字符串

警报的唯一标识符。

lastNotified

字符串

ISO8601 格式的时间戳 上次为此警报发送通知的日期和时间格式（ UTC 格式）。如果MongoDB Ops Manager发送了通知，则 MongoDB MongoDB Ops Manager会显示此内容。

metricName

字符串

Go值超出阈值的测量名称。如果"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"，Ops Manager 返回此字段。

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

replicaSetName

字符串

副本集的名称。 Ops Manager 会为以下类别的警报返回此字段：

resolved

字符串

ISO8601 格式的时间戳 警报关闭时的日期和时间格式（ UTC 格式）。当 "status" : "CLOSED" 时， MongoDB Ops Manager会为全局警报返回此字段。

sourceTypeName

字符串

正在备份的主机类型。 Ops Manager 会为备份类别中的全局警报返回此字段。 可能返回的值包括：

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

status

字符串

警报的当前状态。 可能返回的值包括：

TRACKING

警报条件已存在，但该条件持续的时间不足以触发警报。

OPEN

警报已打开。

CLOSED

警报已关闭。

CANCELLED

警报已取消。

tags

字符串数组

与此警报关联的标签。

typeName

字符串

此字段已弃用，将被忽略。

updated

字符串

ISO8601 格式的时间戳 上次更新此警报时的日期和时间格式（ UTC 格式）。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}"

响应示例

响应标头

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    "alertConfigId": "{ALERT-CONFIG-ID}",
3    "created": "2019-11-30T12:42:31Z",
4    "eventTypeName": "BACKUP_AGENT_DOWN",
5    "groupId": "{PROJECT-ID}",
6    "id": "{ALERT-ID}",
7    "lastNotified": "2020-04-09T20:25:05Z",
8    "links": [
9   ],
10   "status": "OPEN",
11   "tags": [],
12   "typeName": "AGENT",
13   "updated": "2019-11-30T12:42:31Z"
14}

后退

获取全部

来年

确认一个