为一个项目创建一个联合数据库实例和在线归档私有端点

发布 /api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds
服务账户 DigestAuth

添加指定项目中联合数据库实例和在线存档的所有私有端点。如果端点 ID 已存在且关联注释未更改，则 Atlas Data Federation 不会更改端点 ID 列表。如果端点 ID 已存在且关联注释发生更改，则 Atlas Data Federation 仅更新端点 ID 列表中的注释值。如果端点 ID 不存在，Atlas Data Federation 会将新端点附加到端点 ID 列表中的端点列表中。每个区域都有每个区域中各种端点的关联服务名称。

us-east-1 是 com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4。

us-west-1 是 com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb。

eu-west-1 是 com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e。

eu-west-2 是 com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9。

eu-central-1 是 com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d。

sa-east-1 是 com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044。

ap-southeast-2 是 com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e。

ap-south-1 是 com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d。

角色要求
  • 项目所有者

路径参数

  • groupId 字符串 必需

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

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

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

查询参数

  • envelope 布尔

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

    默认值为false 。

  • pretty 布尔

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

    默认值为false 。

    Prettyprint
application/json

body 必需

用于将联合数据库实例和在线存档添加到指定项目的私有端点。

  • azureLinkId 字符串

    标识Azure私有端点连接的链接ID 。

  • comment 字符串

    与此私有端点关联的人类可读字符串。

  • customerEndpointDNSName 字符串

    人类可读标签，用于识别客户的VPC端点 DNS 名称。如果已定义，还必须为 region 指定一个值。

  • customerEndpointIPAddress 字符串

    用于连接到Azure私有端点的IP解决。

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

  • endpointId 字符串 必需

    标识私有端点的唯一字符串。对于 AWS，这是一个 22 字符的字母数字字符串，格式为 vpce-<17 hex characters>。对于Azure，这是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{endpointName} 格式的完整资源ID 。

    配置私有端点以...
  • 错误消息 字符串

    描述批准私有端点请求失败的错误消息。

  • provider 字符串

    用于标识云服务提供商的人类可读标签。Atlas Data Lake支持Amazon Web Services和Azure。

    值为 AWS 或 AZURE。默认值为 AWS。

  • 区域 字符串

    用于标识客户VPC终结点区域的人类可读标签。如果已定义，还必须为 customerEndpointDNSName 指定一个值。

  • 状态 字符串

    私有端点连接请求的状态。

    取值为 PENDING、OK、FAILED 或 DELETING。

  • 类型 字符串

    用户可读的标签，用于标识与此私有端点关联的资源类型。

    值为 DATA_LAKE。默认值为 DATA_LAKE。

响应

  • 201 application/json

    正常

    隐藏响应属性 显示响应属性 对象
    • 链接 大量[对象]

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

      Web 链接规范 (RFC...
      隐藏链接属性 显示链接属性 对象
      • href 字符串

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

      • rel 字符串

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

    • 结果 大量[对象] 必需

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

      隐藏结果属性 显示结果属性 对象
      • azureLinkId 字符串

        标识Azure私有端点连接的链接ID 。

      • comment 字符串

        与此私有端点关联的人类可读字符串。

      • customerEndpointDNSName 字符串

        人类可读标签，用于识别客户的VPC端点 DNS 名称。如果已定义，还必须为 region 指定一个值。

      • customerEndpointIPAddress 字符串

        用于连接到Azure私有端点的IP解决。

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

      • endpointId 字符串 必需

        标识私有端点的唯一字符串。对于 AWS，这是一个 22 字符的字母数字字符串，格式为 vpce-<17 hex characters>。对于Azure，这是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{endpointName} 格式的完整资源ID 。

        配置私有端点以...
      • 错误消息 字符串

        描述批准私有端点请求失败的错误消息。

      • provider 字符串

        用于标识云服务提供商的人类可读标签。Atlas Data Lake支持Amazon Web Services和Azure。

        值为 AWS 或 AZURE。默认值为 AWS。

      • 区域 字符串

        用于标识客户VPC终结点区域的人类可读标签。如果已定义，还必须为 customerEndpointDNSName 指定一个值。

      • 状态 字符串

        私有端点连接请求的状态。

        取值为 PENDING、OK、FAILED 或 DELETING。

      • 类型 字符串

        用户可读的标签，用于标识与此私有端点关联的资源类型。

        值为 DATA_LAKE。默认值为 DATA_LAKE。

    • 总计数 integer(int32)

      可用文档总数。当 includeCount 设置为 false 时，MongoDB 云可能会省略此值，或者在无需额外计算即可获得计数时返回该值。总数是一个估计值，可能不准确。

      最小值为 0。
  • 400 application/json

    错误请求。

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

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

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

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

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

        • 字段 字符串 必需

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

    • 详细信息 字符串 | null

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

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

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 401 application/json

    未经授权。

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

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

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

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

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

        • 字段 字符串 必需

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

    • 详细信息 字符串 | null

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

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

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 403 application/json

    Forbidden.

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

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

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

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

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

        • 字段 字符串 必需

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

    • 详细信息 字符串 | null

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

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

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 404 application/json

    未找到。

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

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

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

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

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

        • 字段 字符串 必需

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

    • 详细信息 字符串 | null

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

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

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
  • 500 application/json

    内部服务器错误。

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

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

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

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

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

        • 字段 字符串 必需

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

    • 详细信息 字符串 | null

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 策略导致决策 大量[对象]

      导致请求被拒绝的Atlas资源策略。仅当 errorCode 为 ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED 时返回。

      不超过 100 个元素。

      隐藏策略CausingDescription 属性 显示 PolicyCausingDescription 属性 对象

      导致请求被拒绝的Atlas资源策略。

      • id 字符串 必需

        唯一的 24-十六进制字符串，用于标识Atlas资源策略。

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

      • 名称 字符串 必需

        用于标识Atlas资源策略的人类可读标签。

    • 原因 字符串 | null

      随此错误返回的应用程序错误消息。
POST /API/Atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds 
curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateNetworkSettings/endpointIds' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "azureLinkId": "string",
  "comment": "string",
  "customerEndpointDNSName": "string",
  "customerEndpointIPAddress": "string",
  "endpointId": "string",
  "errorMessage": "string",
  "provider": "AWS",
  "region": "US_EAST_1",
  "status": "PENDING",
  "type": "DATA_LAKE"
}'
请求示例 
{
  "azureLinkId": "string",
  "comment": "string",
  "customerEndpointDNSName": "string",
  "customerEndpointIPAddress": "string",
  "endpointId": "string",
  "errorMessage": "string",
  "provider": "AWS",
  "region": "US_EAST_1",
  "status": "PENDING",
  "type": "DATA_LAKE"
}
响应示例 (201) 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "azureLinkId": "string",
      "comment": "string",
      "customerEndpointDNSName": "string",
      "customerEndpointIPAddress": "string",
      "endpointId": "string",
      "errorMessage": "string",
      "provider": "AWS",
      "region": "US_EAST_1",
      "status": "PENDING",
      "type": "DATA_LAKE"
    }
  ],
  "totalCount": 42
}
响应示例 (400) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}
响应示例 (401) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
响应示例 (403) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
响应示例 (404) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
响应示例 (500) 
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}