获取所有全局警报配置

检索所有全局警报配置。

所需角色

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

请求

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

GET /globalAlertConfigs

请求路径参数

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

请求查询参数

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用美观打印格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点， `content`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	`false`

请求正文参数

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

响应

响应文档

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

名称	类型	说明
`results`	阵列	数组为`results` 嵌入式文档部分中详细介绍的每一项包含一个对象。
`links`	阵列	数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`totalCount`	数字	结果集中项目总数的整数计数。如果对整个结果集进行分页，则它可能大于results数组中的对象数。

`results` 嵌入式文档

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

名称	类型	说明
`created`	字符串	创建警报配置时采用 ISO 8601 日期和时间格式（UTC 的时间戳）。
`enabled`	布尔	用于指定是否启用警报配置的开关。
`eventTypeName`	字符串	此警报配置Atlas Triggers警报的事件类型。要查看生成警报的事件类型，请参阅警报类型。有关 Ops Manager 审核日志中包含的事件的完整列表，请参阅Audit 事件。
`forAllGroups`	布尔	用于指定全局警报配置是否应用于所有组的开关。还会影响是否可以使用`tags`数组将配置定位到特定群组。如果为`true` ，则配置适用于所有群组。您可以通过`tags`数组将警报配置定位到特定群组。如果为`false` ，则配置仅适用于`groupIds`数组中指定的群组。您必须在`groupIds`数组中至少指定一个项目。您不能将`tags`数组用于此警报配置。
`groupIds`	字符串数组	此警报配置适用的群组的 ID。此字段仅在`forAllGroups`设置为`false`时适用。
`id`	字符串	警报配置的唯一标识符。
`matchers`	对象数组	将对象与此全局警报配置进行匹配时要应用的规则。 MongoDB Ops Manager仅检查符合所有这些警报条件规则的实体。仅当`eventTypeName`指定主机、副本集或分片集群的事件时，才能使用`matchers`数组进行筛选。
`matchers.fieldName`	字符串	目标对象中要匹配的字段的名称。主机警报支持这些字段： `HOSTNAME` `PORT` `HOSTNAME_AND_PORT` `REPLICA_SET_NAME` `TYPE_NAME` 副本集警报支持这些字段： `REPLICA_SET_NAME` `SHARD_NAME` `CLUSTER_NAME` 分片集群警报支持以下字段： `CLUSTER_NAME` `SHARD_NAME` 所有其他类型的警报不支持匹配器。
`matchers.operator`	字符串	用于测试字段值的操作符。可能的值为： `EQUALS` `NOT_EQUALS` `CONTAINS` `NOT_CONTAINS` `STARTS_WITH` `ENDS_WITH` `REGEX`
`matchers.value`	字符串	要使用指定操作符进行测试的值。如果将`matchers.fieldName`设置为`TYPE_NAME` ，则可以匹配以下值： `PRIMARY` `SECONDARY` `STANDALONE` `CONFIG` `MONGOS`
`metricThreshold`	对象	导致此警报配置trigger警报的阈值。仅当`eventTypeName`设置为`OUTSIDE_METRIC_THRESHOLD`时才出现。
`metricThreshold.metricName`	字符串	要检查的指标名称。支持与`globalAlerts`资源的`metricName`字段相同的值。有关可能值的列表，请参阅全局警报的测量类型。
`metricThreshold.mode`	字符串	此项设置为`AVERAGE` ，并将当前指标值计算为平均值。
`metricThreshold.operator`	字符串	根据`metricThreshold.threshold`检查当前指标值时要应用的操作符。可能的值为： `GREATER_THAN` `LESS_THAN`
`metricThreshold.threshold`	数字	阈值，超出此警报配置Atlas Triggers警报。
`metricThreshold.units`	字符串	`metricThreshold.threshold`的单位。单位取决于指标类型。接受的值为： `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS` 示例，测量内存消耗的指标可以使用`BYTES` ，而测量时间的指标则可以使用`HOURS` 。
`notifications`	对象数组	MongoDB Ops Manager在检测到此警报配置描述的警报时发送的通知。
`notifications.apiToken`	字符串	Slack API 令牌或 Bot 令牌。仅针对`SLACK`通知出现。如果令牌后来变得无效， MongoDB Ops Manager会向项目所有者发送电子邮件并删除令牌。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`notifications.channelName`	字符串	Slack 通道名称。仅针对`SLACK`通知出现。
`notifications.delayMin`	数字	检测到警报条件后MongoDB Ops Manager发出第一个通知之前的等待分钟数。
`notifications.emailAddress`	字符串	向其发送通知的电子邮件地址。仅针对`EMAIL`通知出现。
`notifications.emailEnabled`	布尔	指定MongoDB Ops Manager是否发送电子邮件通知。仅针对`GROUP`和`USER`通知出现。
`notifications.intervalMin`	数字	此警报配置Atlas Triggers的未确认、未解决的警报的连续通知之间的等待分钟数。
通知.[n] .webhookSecret	字符串	用于向接受和转发通知的 Webhook 进行身份验证的值。如果您将`notifications.[n].typeName`设置为`WEBHOOK`并且满足以下任一条件，则 Ops Manager 会返回此值：您将`notification.[n].webhookSecret`设置为非空字符串您在管理控制台上设立了默认`webhookSecret` 。创建 Webhook 通知后，当您查看或编辑警报时， URL将被部分编辑，并且密钥将被完全编辑。
通知.[n] .webhookUrl	字符串	Atlas Triggers此通知的 Webhook 的URL 。如果您将`notifications.[n].typeName`设置为`WEBHOOK`并且满足以下任一条件，则 Ops Manager 会返回此值：您将`notification.[n].webhookURL`设置为非空字符串您可以在“管理控制台”页面上设立默认`webhookUrl` 。创建 Webhook 通知后，当您查看或编辑警报时， URL将被部分编辑，并且密钥将被完全编辑。
通知.[n] .webhookHeadersTemplate	字符串	要包含在 Webhook通知中的自定义标头的模板。如果您将 `notifications.[n].typeName` 设立为 `WEBHOOK` 并提供自定义标头模板，Ops Manager 会返回此值。
通知.[n] .webhookBodyTemplate	字符串	Webhook通知正文内容的模板。如果您将 `notifications.[n].typeName` 设立为 `WEBHOOK` 并提供自定义正文模板，Ops Manager 会返回此值。
通知.[n] .oauth2Config	对象	Ops Manager 用于获取 Webhook 通知持有者访问令牌的 OAuth 2.0 客户端凭证。如果您将 `notifications.[n].typeName` 设置为 `WEBHOOK` 并配置 OAuth 2.0 客户端凭证，Ops Manager 将返回此值。
通知.[n] .oauth2Config.tokenUrl	字符串	MongoDB Ops Manager 调用以获取持有者访问令牌的令牌终结点。
通知.[n] .oauth2Config.clientId	字符串	Ops Manager 在向 OAuth 2.0 令牌终结点进行身份验证时使用的客户端标识符。
通知.[n] .oauth2Config.clientSecret	字符串	Ops Manager 在向 OAuth 2.0 令牌终结点进行身份验证时，与客户端 ID 一起使用的客户端密码。
通知.[n] .id	字符串	通知配置的唯一标识符。
`notifications.microsoftTeamsWebhookUrl`	字符串	Microsoft Teams 通道传入的 Webhook URL。仅针对`MICROSOFT_TEAMS`通知出现。当您查看或编辑 Webhook 通知的警报时，URL 会显示为部分遮蔽，而密钥显示为完全遮蔽。
`notifications.notificationToken`	字符串	HipChat API 令牌。仅针对`HIP_CHAT`通知出现。如果令牌后来变得无效， MongoDB Ops Manager会向项目所有者发送电子邮件并删除令牌。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`notifications.roomName`	字符串	HipChat 房间名称。仅针对`HIP_CHAT`通知出现。
`notifications.serviceKey`	字符串	PagerDuty 集成密钥。仅针对`PAGER_DUTY`通知出现。如果密钥后来变得无效， MongoDB Ops Manager会向项目所有者发送电子邮件并删除密钥。创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`notifications.smsEnabled`	布尔	指定MongoDB Ops Manager是否发送短信通知。仅针对`GROUP`和`USER`通知出现。
`notifications.typeName`	字符串	此警报配置Atlas Triggers的警报通知类型。可能的值为： `ADMIN` `GROUP` `USER` `EMAIL` `SMS` （仅当为MongoDB Ops Manager Twilio 集成配置了时才可用。） `HIPCHAT` `SLACK` `PAGER_DUTY`
`notifications.username`	字符串	要向其发送通知的MongoDB Ops Manager用户的名称。仅针对`USER`通知出现。
`threshold`	对象	导致此警报配置trigger警报的阈值。仅当`eventTypeName`设为以下值之一时才出现： `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_UNHEALTHY_MEMBERS`
`threshold.operator`	字符串	根据`threshold.threshold`检查当前指标值时要应用的操作符。可能的值为： `GREATER_THAN` `LESS_THAN`
`threshold.threshold`	数字	阈值，超出此警报配置Atlas Triggers警报。
`tags`	字符串数组	与此警报配置关联的标签。
`typeName`	字符串	此字段已弃用，将被忽略。
`updated`	字符串	上次更新此警报配置时的时间戳，采用 ISO 8601 日期和时间格式（UTC 时间）。

请求示例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2     --header "Accept: application/json" \3     --include \4     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs"

响应示例

响应标头

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 200 OKVary: 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  "links": [3  ],4  "results": [5    {6      "created": "2019-10-02T12:34:04Z",7      "enabled": true,8      "eventTypeName": "RS_BIND_ERROR",9      "forAllGroups": true,10      "groupIds": [],11      "id": "{GLOBAL-ALERT-CONFIG-ID}",12      "links": [13      ],14      "matchers": [],15      "notifications": [16        {17          "delayMin": 0,18          "intervalMin": 60,19          "typeName": "ADMIN"20        }21      ],22      "tags": [],23      "typeName": "BACKUP",24      "updated": "2019-10-02T12:34:04Z"25    },26    {27      "created": "2019-10-02T12:34:04Z",28      "enabled": true,29      "eventTypeName": "BACKUP_TOO_MANY_RETRIES",30      "forAllGroups": true,31      "groupIds": [],32      "id": "{GLOBAL-ALERT-CONFIG-ID}",33      "links": [34      ],35      "matchers": [],36      "notifications": [37        {38          "delayMin": 0,39          "intervalMin": 60,40          "typeName": "ADMIN"41        }42      ],43      "tags": [],44      "typeName": "BACKUP",45      "updated": "2019-10-02T12:34:04Z"46    },47    {48      "created": "2019-10-02T12:34:04Z",49      "enabled": true,50      "eventTypeName": "BACKUP_IN_UNEXPECTED_STATE",51      "forAllGroups": true,52      "groupIds": [],53      "id": "{GLOBAL-ALERT-CONFIG-ID}",54      "links": [55      ],56      "matchers": [],57      "notifications": [58        {59          "delayMin": 0,60          "intervalMin": 60,61          "typeName": "ADMIN"62        }63      ],64      "tags": [],65      "typeName": "BACKUP",66      "updated": "2019-10-02T12:34:04Z"67    }68  ],69  "totalCount": 370}