路径参数

• orgId 字符串 必需

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

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

查询参数

• envelope 布尔

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

  默认值为false 。

• pretty 布尔

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

  默认值为false 。

  Prettyprint

响应

• 200 application/json

  正常

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

  • apiAccessListRequired 布尔

    指示是否要求 API 操作源自添加到指定组织的 API 访问列表中的 IP 地址的标志。

  • customSessionTimeups 对象

    定义用于在组织级别管理用户会话的会话超时设置。当设立为 null 时，将取消设置字段的值，并应用默认超时设置。

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

    • abstractSessionTimeoutInSeconds integer(int32)

      指定绝对会话超时持续时间（以秒为单位）。当设立为 null 时，表示未设置该字段的值，并应用默认值 43,200 秒（12 小时）。接受的值范围是最小值 3 600 秒（1 小时）和最大值 43 200 秒（12 小时）。

    • idleSessionTimeoutInSeconds integer(int32)

      指定空闲会话超时持续时间（以秒为单位）。当设立为 null 时，表示未设置该字段的值，并且默认行为取决于上下文： Atlas商业版没有超时， Atlas政府版没有超时。600 秒（10 分钟）。接受的值至少从 300 秒（5 分钟）开始。对于Atlas Commercial，最大值不能超过配置的绝对会话超时。对于Atlas for Government，最大值的上限为 600 秒（10 分钟）。

  • genAIFeaturesEnabled 布尔

    指示该组织是否有权访问权限生成AI功能的标志。 此设置仅适用于Atlas商业版，并且默认处于启用状态。 开启此设置后，项目所有者也许能够在项目级别启用或禁用单个AI功能。

    默认值为true 。

    生成式 AI 常见问题解答
  • maxServiceAccountSecretValidityInHours integer(int32)

    一个数字，表示指定组织内新的Atlas Admin API服务帐户密钥在过期之前的最长时间（以小时为单位）。

    最小值为 8，最大值为 8760。

  • multiFactorAuthRequired 布尔

    指示是否要求用户在访问指定组织之前设置多重身份验证 (MFA)的标记。如需了解更多信息，请访问：https://www.mongodb.com/zh-cn/docs/atlas/security-multi-factor-authentication/。

  • restrictEmployeeAccess 布尔

    该标志指示是否阻止 MongoDB 支持团队在未获得明确许可的情况下访问指定组织中任何部署的 Atlas 基础架构和集群日志。启用此设置后，您可以向 MongoDB 支持团队授予对 Atlas 部署的 24 小时旁路访问权限，以解决支持问题。如需了解更多信息，请访问：https://www.mongodb.com/zh-cn/docs/atlas/security-restrict-support-access/。

  • securityContact 字符串

    string字符串，为指定组织指定单个电子邮件解决，用于接收安全相关通知。指定安全联系并不授予他们授权或访问权限Atlas以进行安全决策或批准。 string空字符串有效，会清除现有安全联系（如有）。

  • streamsCrossGroupEnabled 布尔

    指示该组织中群组的Atlas Stream Processing实例是否可以创建与同一组织中其他群组集群的连接的标志。

• 400 application/json

  错误请求。

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

  • badRequestDetail 对象

    错误请求详情。

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

    • 字段 大量[对象]

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

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

      • 描述 字符串 必需

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

      • 字段 字符串 必需

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

  • 详细信息 字符串

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

  • 错误 integer(int32) 必需

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

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

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

  • 参数 大量[对象]

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

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

• 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 状态代码。

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

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

  • 参数 大量[对象]

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

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

• 429 application/json

  请求过多。

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

  • badRequestDetail 对象

    错误请求详情。

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

    • 字段 大量[对象]

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

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

      • 描述 字符串 必需

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

      • 字段 字符串 必需

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

  • 详细信息 字符串

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

  • 错误 integer(int32) 必需

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

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

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

  • 参数 大量[对象]

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

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

• 500 application/json

  内部服务器错误。

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

  • badRequestDetail 对象

    错误请求详情。

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

    • 字段 大量[对象]

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

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

      • 描述 字符串 必需

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

      • 字段 字符串 必需

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

  • 详细信息 字符串

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

  • 错误 integer(int32) 必需

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

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

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

  • 参数 大量[对象]

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

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