路径参数

• groupId 字符串 必需

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

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

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

• entryValue 字符串 必需

  您要从项目的 IP 访问列表中返回的访问列表条目。该值可以使用以下值之一：一个 AWS 安全组 ID、一个 IP 地址或一个 CIDR 地址区块。对于使用子网掩码的 CIDR 区块，将正斜杠 (/) 替换为其 URL 编码值 (%2F)。

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

查询参数

• envelope 布尔

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

  默认值为false 。

• pretty 布尔

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

  默认值为false 。

  Prettyprint

响应

• 200 application/json

  正常

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

  • awsSecurityGroup 字符串

    要添加到项目的 IP 访问列表的 Amazon Web Services (AWS) 安全群组的唯一字符串。您的 IP 访问列表条目可以是 1 个 awsSecurityGroup、1 个 cidrBlock 或 1 个 ipAddress。您必须先为项目配置虚拟专用连接 (VPC) 对等互连，然后才能将 AWS 安全群组添加到 IP 访问列表。您无法将 AWS 安全群组设置为临时访问列表条目。如果设置 cidrBlock 或 ipAddress，请勿设置此参数。

    格式应符合以下模式：^([0-9]*/)?sg-([0-9]*)。

  • cidrBlock 字符串

    您想要添加到项目 IP 访问列表的 IP 地址范围，采用无类域间路由 (CIDR) 表示法。您的 IP 访问列表条目可以是 1 个 awsSecurityGroup、1 个 cidrBlock 或 1 个 ipAddress。如果设置了 awsSecurityGroup 或 ipAddress，请勿设置此参数。

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

  • comment 字符串

    解释此 IP 访问列表条目的用途或范围的注释。

    最大长度为 80。

  • deleteAfterDate string(date-time)

    MongoDB Cloud 删除临时访问列表条目的日期和时间。此参数以 ISO 8601 时间戳格式（UTC 格式）表示其值，可以包括时区名称。该日期必须晚于当前日期，但不得晚于您提交此请求后的一周。如果您在创建此 IP 访问列表条目时指定了到期日期，则资源会返回此参数。

  • groupId 字符串

    唯一的 24-十六进制数字字符串，用于标识包含要添加一个或多个条目的IP访问列表的项目。

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

  • IP 地址 字符串

    要添加到项目 IP 访问列表的 IP 地址。您的 IP 访问列表条目可以是 1 个 awsSecurityGroup、1 个 cidrBlock 或 1 个 ipAddress。如果设置了 awsSecurityGroup 或 cidrBlock，请勿设置此参数。

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

  • 链接 大量[对象]

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

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

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

  • 参数 大量[对象]

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

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

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

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

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

  • 参数 大量[对象]

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

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