返回一个项目中的所有网络对等连接
返回有关指定项目中所有网络对等连接的详细信息。网络对等互连允许多个云托管应用程序安全地连接到同一项目。要使用此资源，请求的服务账户或 API 密钥必须具有“项目只读”角色。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式：
^([a-f0-9]{24})$。
查询参数
-
指示应用程序是否将响应包装在
envelopeJSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false。 -
标志，用于指示响应是否返回响应中的列项总数 (totalCount)。
默认值为
true。 -
响应每页返回的列项数。
最小值为
1，最大值为500。默认值为100。 -
显示响应返回的当前总对象集的页面编号。
最小值为
1。默认值为1。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false。Prettyprint -
用于此 VPC 对等连接的云服务提供商。
值为
AWS、AZURE或GCP。默认值为AWS。
GET /API/Atlas/v1.0/groups/{groupId}/peers
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/peers' \
--header "Authorization: Bearer $ACCESS_TOKEN"
响应示例 (200)
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"containerId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"providerName": "AWS",
"accepterRegionName": "string",
"awsAccountId": "string",
"connectionId": "string",
"errorStateName": "REJECTED",
"routeTableCidrBlock": "string",
"statusName": "INITIATING",
"vpcId": "string"
}
],
"totalCount": 42
}
响应示例 (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"
}