路径参数

• groupId 字符串 必需

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

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

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

查询参数

• envelope 布尔

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

  默认值为false 。

• pretty 布尔

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

  默认值为false 。

  Prettyprint

响应

• 200 application/json

  正常

  隐藏响应属性 显示响应属性 对象

  • autoDeferOnceEnabled 布尔

    指示 MongoDB Cloud 是否应在启用所有维护窗口后将其推迟一周的标志。

  • dayOfWeek integer(int32) 必需

    基于 1 的整数，表示维护窗口开始的具体星期几。

    • 1：星期日。
    • 2：星期一。
    • 3：星期二。
    • 4：星期三。
    • 5：星期四。
    • 6：星期五。
    • 7：星期六。

    最小值为 1，最大值为 7。

  • hourOfDay integer(int32)

    从零开始的整数，表示维护窗口按照 24 小时制开始的当天中的某个小时。午夜使用 0，中午使用 12。

    最小值为 0，最大值为 23。

  • numberOfDeferrals integer(int32)

    此项目的当前维护事件已推迟的次数。

  • protectedHours 对象

    定义不会开始维护的窗口。

    隐藏 protectedHours 属性 显示 protectedHours 属性 对象

    • endHourOfDay integer(int32)

      从零开始的整数，表示维护不会开始的那一天的结束时间。

      最小值为 0，最大值为 23。

    • startHourOfDay integer(int32)

      从零开始的整数，表示维护不在当天的开始时间。

      最小值为 0，最大值为 23。

  • startASAP 布尔

    标志，表示 MongoDB Cloud 是否在收到此请求后立即启动维护窗口。如需立即启动项目的维护窗口，MongoDB Cloud 必须安排了维护，而且您必须设置维护窗口。MongoDB Cloud 完成维护后，该标记会重置为 false。

  • timeZoneId 字符串

    维护窗口当前时区域的标识符。这只能通过“项目设置”用户界面进行更新。

• 401 application/json

  未经授权。

  隐藏响应属性 显示响应属性 对象

  • badRequestDetail 对象

    错误请求详情。

    隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象

    • 字段 大量[对象]

      描述客户端请求中的所有违规行为。

      隐藏字段属性 显示字段属性 对象

      • 描述 字符串 必需

        关于请求元素错误的原因的描述。

      • 字段 字符串 必需

        指向请求正文中字段的路径。

  • 详细信息 字符串

    描述导致每种错误类型的具体条件或原因。

  • 错误 integer(int32) 必需

    与此错误一起返回的 HTTP 状态代码。

    外部文档
  • 错误代码 字符串 必需

    返回此错误时附带应用程序错误代码。

  • 参数 大量[对象]

    用于提供更多错误信息的参数。
  • 原因 字符串

    随此错误返回的应用程序错误消息。

• 403 application/json

  Forbidden.

  隐藏响应属性 显示响应属性 对象

  • badRequestDetail 对象

    错误请求详情。

    隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象

    • 字段 大量[对象]

      描述客户端请求中的所有违规行为。

      隐藏字段属性 显示字段属性 对象

      • 描述 字符串 必需

        关于请求元素错误的原因的描述。

      • 字段 字符串 必需

        指向请求正文中字段的路径。

  • 详细信息 字符串

    描述导致每种错误类型的具体条件或原因。

  • 错误 integer(int32) 必需

    与此错误一起返回的 HTTP 状态代码。

    外部文档
  • 错误代码 字符串 必需

    返回此错误时附带应用程序错误代码。

  • 参数 大量[对象]

    用于提供更多错误信息的参数。
  • 原因 字符串

    随此错误返回的应用程序错误消息。

• 404 application/json

  未找到。

  隐藏响应属性 显示响应属性 对象

  • badRequestDetail 对象

    错误请求详情。

    隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象

    • 字段 大量[对象]

      描述客户端请求中的所有违规行为。

      隐藏字段属性 显示字段属性 对象

      • 描述 字符串 必需

        关于请求元素错误的原因的描述。

      • 字段 字符串 必需

        指向请求正文中字段的路径。

  • 详细信息 字符串

    描述导致每种错误类型的具体条件或原因。

  • 错误 integer(int32) 必需

    与此错误一起返回的 HTTP 状态代码。

    外部文档
  • 错误代码 字符串 必需

    返回此错误时附带应用程序错误代码。

  • 参数 大量[对象]

    用于提供更多错误信息的参数。
  • 原因 字符串

    随此错误返回的应用程序错误消息。

• 500 application/json

  内部服务器错误。

  隐藏响应属性 显示响应属性 对象

  • badRequestDetail 对象

    错误请求详情。

    隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象

    • 字段 大量[对象]

      描述客户端请求中的所有违规行为。

      隐藏字段属性 显示字段属性 对象

      • 描述 字符串 必需

        关于请求元素错误的原因的描述。

      • 字段 字符串 必需

        指向请求正文中字段的路径。

  • 详细信息 字符串

    描述导致每种错误类型的具体条件或原因。

  • 错误 integer(int32) 必需

    与此错误一起返回的 HTTP 状态代码。

    外部文档
  • 错误代码 字符串 必需

    返回此错误时附带应用程序错误代码。

  • 参数 大量[对象]

    用于提供更多错误信息的参数。
  • 原因 字符串

    随此错误返回的应用程序错误消息。