Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
测量和警报
/
警报配置

获取警报配置的打开警报

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

注意

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

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts

请求路径参数

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

Parameter
类型
说明

PROJECT-ID

字符串

此项目的唯一标识符。

ALERT-CONFIG-ID

字符串

此警报配置的唯一标识符。

请求查询参数

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

名称
类型
必要性
说明
默认

pageNum

数字

Optional

从一开始的整数，用于返回结果的一部分。

1

itemsPerPage

数字

Optional

每页要返回的项目数，最多 500 个。

100

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 envelope : true。

对于返回结果列表的端点，content 对象是一个信封。Cloud Manager 将 status 字段添加到响应正文。

false

backupJobsEnabledOnly

布尔

Optional

指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为false以包含将backupJobsEnabled标志设置为false的守护进程配置。

true

请求正文参数

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

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称
类型
说明

results

阵列

数组为results 嵌入式文档 部分中详细介绍的每一项包含一个对象。

links

阵列

数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

totalCount

数字

结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。

results 嵌入式文档

每个结果都是一个警报配置。

注意

警报详细信息各不相同。 警报可能仅包含这些元素的子集。

名称
类型
说明

acknowledgedUntil

字符串

ISO8601 格式的时间戳 确认警报的日期和时间（ UTC 格式）。如果警报已得到确认，则填充。

acknowledgedUsername

字符串

确认警报的用户的用户名。如果警报已得到确认，则填充。

acknowledgementComment

字符串

确认警报的评论用户离开。 如果警报已得到确认，则填充。

alertConfigId

字符串

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

clusterId

字符串

此警报适用的集群的唯一标识符。 针对BACKUP 、 REPLICA_SET和CLUSTER警报进行填充。

集群名称

字符串

为适用此警报的集群命名。 针对BACKUP 、 REPLICA_SET和CLUSTER警报进行填充。

已创建

字符串

ISO 格式的时间戳8601 打开警报时的日期和时间格式（ UTC 格式）。

currentValue

对象

触发警报的指标的当前值。 已填充HOST_METRIC警报。

currentValue.number

数字

指标的值。

currentValue.units

字符串

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

示例，测量内存消耗的指标将具有字节测量值，而测量时间的指标将具有时间单位。 接受的值为：

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName

字符串

触发警报的事件的名称。

值包括：

助手

自动化配置

备份

BI Connector

帐单

集群

已访问数据浏览器

磁盘备份

主机

组织

项目

副本集(Replica Set)

支持案例

团队

user

要查看生成警报的事件的完整列表及其描述，请参阅警报类型。

groupId

字符串

为其打开警报的项目的唯一标识符。

hostId

字符串

指标所属主机的唯一标识符。 针对HOST 、 HOST_METRIC和REPLICA_SET警报进行填充。

主机名和端口

字符串

警报适用的每个主机的主机名和端口。 针对HOST 、 HOST_METRIC和REPLICA_SET警报进行填充。

id

字符串

警报的唯一标识符。

lastNotified

字符串

ISO8601 格式的时间戳 上次为此警报发送通知的日期和时间格式（ UTC 格式）。如果已发送通知，则填充。

metricName

字符串

其值超出阈值的测量名称。 如果"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"则填充。

有关接受的值，请参阅本页上的警报测量类型。

ReplicaSetName

字符串

副本集的名称。 针对HOST 、 HOST_METRIC 、 BACKUP和REPLICA_SET警报进行填充。

已解决

字符串

ISO8601 格式的时间戳 警报关闭时的日期和时间格式（ UTC 格式）。如果"status" : "CLOSED"则填充。

sourceTypeName

字符串

对于BACKUP警报，正在备份的服务器的类型。 接受的值为：

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

状态

字符串

警报的当前状态。 接受的值为：

  • TRACKING

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

  • OPEN

  • CLOSED

  • CANCELLED

typeName

字符串

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

Updated

字符串

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

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts"

响应示例

响应标头

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}

响应体

{
  "links" : [],
  "results" : [ {
    "acknowledgedUntil" : "2014-05-01T14:00:00Z",
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T15:57:13.562Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "53569159300495c7702ee3a3",
    "lastNotified" : "2014-04-22T15:57:24.126Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  }, {
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T19:59:10.657Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "5356ca0e300495c770333340",
    "lastNotified" : "2014-04-22T20:14:19.313Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  } ],
  "totalCount" : 2
}

后退

删除

来年

事件(Events)