Devuelve el estado de conexión del extremo privado especificado. El servicio de endpoint privado gestiona este endpoint privado, el cual pertenece a un proyecto alojado por un proveedor de servicios en la nube. Para utilizar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de Proyecto Solo Lectura.
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Proveedor de servicios en la nube que gestiona este nodo privado.
Los valores son
AWS,AZUREoGCP. El valor predeterminado esAWS. -
string única que identifica el nodo privado que deseas devolver. El formato del parámetro
endpointIddifiere para AWS y Azure. Debe codificar en URL elendpointIdpara los nodos privados de Azure.El formato debe coincidir con el siguiente patrón:
^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\w._()]+)%2[fF]providers%2[fF]Microsoft\.Network%2[fF]privateEndpoints%2[fF]([-\w._()]+). -
Cadena única de 24 dígitos hexadecimales que identifica el servicio de nodo privado para el cual se desea devolver un nodo privado.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"cloudProvider": "AWS",
"deleteRequested": true,
"errorMessage": "string",
"connectionStatus": "PENDING_ACCEPTANCE",
"interfaceEndpointId": "string"
}{
"cloudProvider": "AZURE",
"deleteRequested": true,
"errorMessage": "string",
"privateEndpointConnectionName": "string",
"privateEndpointIPAddress": "string",
"privateEndpointResourceId": "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln",
"status": "INITIATING"
}{
"cloudProvider": "GCP",
"deleteRequested": true,
"errorMessage": "string",
"endpointGroupName": "string",
"endpoints": [
{
"endpointName": "string",
"ipAddress": "string",
"status": "INITIATING"
}
],
"gcpProjectId": "string",
"portMappingEnabled": true,
"status": "INITIATING"
}{
"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"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}