返回一个提供者的所有私有端点服务

获取 /api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService

服务账户 DigestAuth

返回指定云服务提供商的所有私有端点服务的名称、接口和状态。该云服务提供商负责管理项目的私有端点服务。要使用此资源，请求的服务账户或 API 密钥必须具有“项目只读”角色。

路径参数

groupId 字符串必需

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

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

格式应符合以下模式：^([a-f0-9]{24})$。
云服务提供商字符串必需

管理此私有端点服务的云服务提供商。

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

查询参数

envelope 布尔

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

默认值为false 。
pretty 布尔

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

默认值为false 。

Prettyprint

响应

200 application/json

正常
以下之一：
AWS对象 AZURE对象 GCP对象
私有端点服务设置群组。

隐藏属性显示属性

云服务提供商字符串必需鉴别器

为所请求的端点服务提供服务的云服务提供商。

值为 AWS。

错误消息字符串

请求专用连接资源时返回错误消息。如果请求成功，资源将返回 null。

id 字符串

唯一的 24-十六进制数字字符串，用于标识私有端点服务。

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

regionName 字符串

管理此私有端点服务的云提供商地区。

状态字符串

MongoDB Cloud 收到此请求时私有端点服务连接的状态。

取值为 INITIATING、AVAILABLE、WAITING_FOR_USER、FAILED 或 DELETING。

endpointServiceName 字符串

用于标识Amazon Web Services (AWS) PrivateLink 端点服务的唯一字符串。 MongoDB Cloud 在创建端点服务时返回 null。

格式应符合以下模式：^com\.amazonaws\.vpce\.[a-z-0-9]+\.vpce-svc-[0-9a-f]{17}。

interfaceEndpoints array[string]

字符串列表，用于标识应用于指定项目的私有端点接口。

每个的格式应符合以下模式：^([a-f0-9]{24})$。
私有端点服务设置群组。

隐藏属性显示属性

云服务提供商字符串必需鉴别器

为所请求的端点服务提供服务的云服务提供商。

值为 AZURE。

错误消息字符串

请求专用连接资源时返回错误消息。如果请求成功，资源将返回 null。

id 字符串

唯一的 24-十六进制数字字符串，用于标识私有端点服务。

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

regionName 字符串

管理此私有端点服务的云提供商地区。

状态字符串

MongoDB Cloud 收到此请求时私有端点服务连接的状态。

取值为 INITIATING、AVAILABLE、WAITING_FOR_USER、FAILED 或 DELETING。

privateEndpoints array[string]

分配给此Azure Private Link服务的私有端点列表。

每个的格式应符合以下模式：^\/subscriptions\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/resource[gG]roups\/([-\w._()]+)\/providers\/Microsoft\.Network\/privateEndpoints\/([-\w._()]+)。

privateLinkServiceName 字符串

标识MongoDB Cloud 管理的Azure Private Link服务的唯一字符串。

格式应符合以下模式：^pls_[0-9a-f]{24}$。

privateLinkServiceResourceId 字符串

标识MongoDB Cloud 管理的Azure Private Link Service 的根相对路径。使用此值可创建与Azure VNet 的私有端点连接。
私有端点服务设置群组。

隐藏属性显示属性

云服务提供商字符串必需鉴别器

为所请求的端点服务提供服务的云服务提供商。

值为 GCP。

错误消息字符串

请求专用连接资源时返回错误消息。如果请求成功，资源将返回 null。

id 字符串

唯一的 24-十六进制数字字符串，用于标识私有端点服务。

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

regionName 字符串

管理此私有端点服务的云提供商地区。

状态字符串

MongoDB Cloud 收到此请求时私有端点服务连接的状态。

取值为 INITIATING、AVAILABLE、WAITING_FOR_USER、FAILED 或 DELETING。

endpointGroupNames array[string]

与 Private Service Connect 端点服务对应的 Google Cloud 网络端点组列表。

serviceAttachmentNames array[string]

统一资源定位符 (URL) 列表，用于标识MongoDB Cloud 可用于通过 Google Cloud 虚拟专用连接 ( VPC ) 网络访问权限一个 Google Cloud Service 的端点。

每个的格式应符合以下模式：https:\/\/([a-z0-9\.]+)+\.[a-z]{2,}(\/[a-z0-9\-]+)+\/projects\/p-[a-z0-9]+\/regions\/[a-z\-0-9]+\/serviceAttachments\/[a-z0-9\-]+。
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 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
500 application/json

内部服务器错误。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。

GET /API/Atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateEndpoint/{cloudProvider}/endpointService' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

响应示例 (200)

[
  {
    "cloudProvider": "AWS",
    "errorMessage": "string",
    "id": "32b6e34b3d91647abb20e7b8",
    "regionName": "string",
    "status": "INITIATING",
    "endpointServiceName": "string",
    "interfaceEndpoints": [
      "32b6e34b3d91647abb20e7b8"
    ]
  }
]

响应示例 (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

响应示例 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

响应示例 (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

响应示例 (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

响应示例 (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}