为一个无服务器实例返回一个私有端点

获取 /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}

服务账户 DigestAuth

返回一个无服务器实例的所有私有端点。使用其唯一 ID 标识此端点。您必须至少具有项目的“项目只读”角色才能成功调用此资源。

此功能不适用于 Flex 集群。要在 Flex 取代“无服务器”后继续使用私有终结点，请改用专用集群。

路径参数

groupId 字符串必需

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

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

格式应符合以下模式：^([a-f0-9]{24})$。
实例名称字符串必需

人类可读标签，用于标识与租户端点关联的无服务器实例。

格式应符合以下模式：^[a-zA-Z0-9][a-zA-Z0-9-]*$。
endpointId 字符串必需

标识租户端点的唯一 24 位十六进制数字字符串。

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

查询参数

envelope 布尔

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

默认值为false 。

响应

200 application/vnd.atlas.2023-01-01+json

正常
以下之一：
ServerlessAWSTenantEndpoint对象 ServerlessAzureTenantEndpoint对象
无服务器AWS 租户端点的视图。

隐藏属性显示属性

_id 字符串

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

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

cloudProviderEndpointId 字符串

标识私有端点的网络接口的唯一字符串。

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

comment 字符串

与私有端点关联的人类可读注释。

最大长度为 80。

endpointServiceName 字符串

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

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

错误消息字符串

人类可读的错误消息，指示与建立私有端点连接相关的错误情况。

状态字符串

人类可读标签，指示私有端点的当前操作状态。

取值为 RESERVATION_REQUESTED、RESERVED、INITIATING、AVAILABLE、FAILED 或 DELETING。

提供商名称字符串

用于标识云服务提供商的人类可读标签。

值为 AWS。
无服务器Azure租户端点的视图。

隐藏属性显示属性

_id 字符串

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

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

cloudProviderEndpointId 字符串

唯一字符串，用于标识有人添加到此私有端点服务的Azure私有端点的网络接口。

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

comment 字符串

与私有端点关联的人类可读注释。

最大长度为 80。

endpointServiceName 字符串

标识Azure私有端点服务的唯一字符串。 MongoDB Cloud 在创建端点服务时返回 null。

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

错误消息字符串

人类可读的错误消息，指示与建立私有端点连接相关的错误情况。

状态字符串

人类可读标签，指示私有端点的当前操作状态。

取值为 RESERVATION_REQUESTED、RESERVED、INITIATING、AVAILABLE、FAILED 或 DELETING。

privateEndpointIpAddress 字符串

有人添加到此私有端点服务的Azure VNet 中私有端点的 IPv4解决。

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

privateLinkServiceResourceId 字符串

标识MongoDB Cloud 管理的Azure Private Link Service 的根相对路径。 MongoDB Cloud 在创建端点服务时返回 null。

提供商名称字符串

用于标识云服务提供商的人类可读标签。

值为 AZURE。
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/v2 /groups/{groupId}/privateEndpoint/ 无服务器/ 实例/{instanceName}/endpoint/{endpointId}

atlas api serverlessPrivateEndpoints getGroupPrivateEndpointServerlessInstanceEndpoint --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetGroupPrivateEndpointServerlessInstanceEndpointApiParams{}
	sdkResp, httpResp, err := client.ServerlessPrivateEndpointsApi.
		GetGroupPrivateEndpointServerlessInstanceEndpointWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true"

响应示例 (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "cloudProviderEndpointId": "string",
  "comment": "string",
  "endpointServiceName": "string",
  "errorMessage": "string",
  "status": "RESERVATION_REQUESTED",
  "providerName": "AWS"
}

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "cloudProviderEndpointId": "string",
  "comment": "string",
  "endpointServiceName": "string",
  "errorMessage": "string",
  "status": "RESERVATION_REQUESTED",
  "privateEndpointIpAddress": "string",
  "privateLinkServiceResourceId": "string",
  "providerName": "AZURE"
}

响应示例 (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"
}