查询参数

• envelope 布尔

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

  默认值为false 。

• pretty 布尔

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

  默认值为false 。

  Prettyprint

响应

• 200 application/json

  正常

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

  • apiKey 对象| null 必需

    一个API密钥中包含的详细信息。

    隐藏 apiKey 属性 显示 apiKey 属性 对象| null

    • accessList 大量[对象]

      使用此API密钥授予对此API访问权限权限的网络地址列表。

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

      • cidrBlock 字符串

        在此项目的访问权限列表中找到的采用无类别域间路由 (CIDR) 表示法的IP地址范围。

        格式应符合以下模式：^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$。

      • IP 地址 字符串 必需

        API访问权限列表中包含的IP解决。

        格式应符合以下模式：^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$。

    • id 字符串 必需

      唯一的 24 位十六进制数字字符串，用于标识此组织 API 密钥。

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

    • publicKey 字符串 必需

      为指定的组织API密钥设立的公用API密钥值。

      最小长度为 8，最大长度为 8。

    • 角色 大量[对象]

      包含API密钥所需角色的列表。您提供的所有角色必须对指定的项目或组织有效。每个请求必须至少包含一个有效角色。该资源会返回分配给该 Cloud 用户的所有项目和组织角色。

      MongoDB Cloud 用户的角色以及该角色适用的相应组织或项目。每个角色只能应用一个组织或一个项目，但不能同时应用于两者。

      隐藏角色属性 显示角色属性 对象

      • groupId 字符串

        唯一的24 -十六进制数字字符串，用于标识此角色所属的项目。您可以为此参数或 orgId设立值，但不能在同一请求中同时设置两者。

        最小长度为 24，最大长度为 24。格式应符合以下模式：^([a-f0-9]{24})$。

      • orgId 字符串

        唯一的24 -十六进制数字字符串，用于标识此角色所属的组织。您可以为此参数或 groupId设立值，但不能在同一请求中同时设置两者。

        最小长度为 24，最大长度为 24。格式应符合以下模式：^([a-f0-9]{24})$。

      • roleName 字符串

        人类可读标签，用于标识MongoDB Cloud 授予特定API密钥、 MongoDB Cloud 用户或MongoDB Cloud团队的权限集合。这些角色包括组织级角色和项目级角色。

        值为 ORG_MEMBER、ORG_READ_ONLY、ORG_STREAM_PROCESSING_ADMIN、ORG_BILLING_ADMIN、ORG_BILLING_READ_ONLY、ORG_GROUP_CREATOR、ORG_OWNER、GROUP_OWNER、GROUP_READ_ONLY、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、 GROUP_CLUSTER_MANAGER、GROUP_SEARCH_INDEX_EDITOR、GROUP_STREAM_PROCESSING_OWNER、GROUP_BACKUP_MANAGER、GROUP_OBSERVABILITY_VIEWER 或 GROUP_DATABASE_ACCESS_ADMIN。

  • appName 字符串 必需

    人类可读标签，用于标识您向其请求此响应的服务。

    值为 MongoDB Atlas。

  • 构建 字符串 必需

    唯一的 40-十六进制数字哈希，用于标识为此应用程序合并的最新 git提交。

  • 链接 大量[对象]

    点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

    Web 链接规范 (RFC 5988)
    隐藏链接属性 显示链接属性 对象

    • href 字符串

      统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

    • rel 字符串

      统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

  • 节流 布尔 必需

    指示是否有人对此服务启用限制的标志。

• 401 application/json

  未经授权。

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

  • badRequestDetail 对象

    错误请求详情。

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

    • 字段 大量[对象]

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

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

      • 描述 字符串 必需

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

      • 字段 字符串 必需

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

  • 详细信息 字符串

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

  • 错误 integer(int32) 必需

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

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

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

  • 参数 大量[对象]

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

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

• 500 application/json

  内部服务器错误。

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

  • badRequestDetail 对象

    错误请求详情。

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

    • 字段 大量[对象]

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

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

      • 描述 字符串 必需

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

      • 字段 字符串 必需

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

  • 详细信息 字符串

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

  • 错误 integer(int32) 必需

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

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

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

  • 参数 大量[对象]

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

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