Agrega un punto final privado para las instancias federadas de base de datos y los archivos en línea a los Proyectos especificados. Si el ID del endpoint ya existe y el comentario asociado no ha cambiado, Atlas Data Federation no realiza ningún cambio en la lista de ID de endpoint. Si el ID del endpoint ya existe y se cambia el comentario asociado, Atlas Data Federation actualiza el valor del comentario solo en la lista de IDs de endpoint. Si el ID del endpoint no existe, Atlas Data Federation agrega el nuevo endpoint a la lista de endpoints en la lista de IDs de endpoints. Cada región tiene un nombre de servicio asociado para los diferentes endpoints en cada región.
us-east-1 es com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4.
us-west-1 es com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb.
eu-west-1 es com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e.
eu-west-2 es com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9.
eu-central-1 es com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d.
sa-east-1 es com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044.
ap-southeast-2 es com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e.
ap-south-1 es com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d.
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})$.
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.
Endpoint privado para instancias de bases de datos federadas y ficheros en línea para agregar al proyecto especificado.
ID de enlace que identifica la conexión de terminal privada de Azure.
Cadena legible por personas para asociar con este nodo privado.
Etiqueta legible por humanos para identificar el nombre de DNS del endpoint VPC del cliente. Si se define, también debe especificar un valor para region.
Dirección IP utilizada para conectar al punto final privado de Azure.
El formato debe coincidir con el siguiente patrón: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.
string única que identifica el nodo privado. Para AWS, se trata de una string alfanumérica de 22caracteres en el formato vpce-<17 hex characters>. Para Azure, este es el ID completo del recurso en el formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{endpointName}.
Mensaje de error que describe un fallo al aprobar la solicitud de nodo privado.
Etiqueta legible por humanos que identifica al proveedor del servicio en la nube. Atlas Data Lake admite Amazon Web Services y Azure.
Los valores son AWS o AZURE. El valor por defecto es AWS.
Etiqueta legible por humanos para identificar la región del endpoint VPC del cliente. Si se define, también debe especificar un valor para customerEndpointDNSName.
Estado de la solicitud de conexión de nodos privados.
Los valores son PENDING, OK, FAILED o DELETING.
Etiqueta legible por humanos que identifica el tipo de recurso asociado con este endpoint privado.
El valor es DATA_LAKE. El valor por defecto es DATA_LAKE.
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"
}
{
"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
}
{
"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"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}
{
"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"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}