返回一个项目中的所有警报配置

获取 /api/atlas/v1.0/groups/{groupId}/alertConfigs

返回一个项目的所有警报配置。这些警报配置适用于项目中的任何组件。警报配置定义了警报的触发条件和通知方法。

此资源仍在修订中,可能会有变动。

角色要求
  • 项目只读

路径参数

  • groupId 字符串 必需

    用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

    注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

    格式应符合以下模式:^([a-f0-9]{24})$。

查询参数

  • envelope 布尔

    指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

    默认值为false 。

  • includeCount 布尔

    指示MongoDB Cloud 是否计算响应的项目总数的标志。设立为 false 时, MongoDB Cloud 可能会跳过额外的计数操作。当计数可用而无需额外计算时,响应仍可能包括 totalCount。

    默认值为true 。

  • itemsPerPage 整型

    响应每页返回的列项数。

    最小值为 1,最大值为 500。默认值为 100。

  • pageNum 整型

    显示响应返回的当前总对象集的页面编号。

    最小值为 1。默认值为 1。

  • pretty 布尔

    指示响应正文是否应采用 prettyprint 格式的标记。

    默认值为false 。

    Prettyprint

响应

  • 200 application/json

    正常

    隐藏响应属性 显示响应属性 对象
    • 结果 大量[对象] 必需

      MongoDB Cloud 在完成此请求时提供的返回文档列表。

      以下之一: