Crea una instancia federada de base de datos y un endpoint privado de fichero en linea para un Proyecto

publicación /api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds

Cuentas de servicio Autenticación Digest

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.

Requisitos del rol

Propietario del proyecto

Parámetros de path

ID del grupo string Requerido

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})$.

Parámetros de query

envelope booleano

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.
bonito booleano

Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

El valor por defecto es false.

pretty-print

application/json

Cuerpo Requerido

Endpoint privado para instancias de bases de datos federadas y ficheros en línea para agregar al proyecto especificado.

azureLinkId string

ID de enlace que identifica la conexión de terminal privada de Azure.
comment string

Cadena legible por personas para asociar con este nodo privado.
customerEndpointDNSName string

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.
customerEndpointIPAddress string

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}$.
endpointId string Requerido

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}.

Configura nodos privados pa...
mensaje de error string

Mensaje de error que describe un fallo al aprobar la solicitud de nodo privado.
Proveedor string

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.
region string

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 string

Estado de la solicitud de conexión de nodos privados.

Los valores son PENDING, OK, FAILED o DELETING.
tipo string

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.

Respuestas

201 application/json

OK
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- enlaces arreglo[objeto]
  
  Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.
  
  Especificación de vinculación web (RFC...
  
  Ocultar atributos de enlaces Mostrar los atributos de los enlaces Objeto
  
  href string
  
  Localizador uniforme de recursos (URL) que señala otro recurso de la API con el que esta respuesta guarda relación. Esta URL suele comenzar con https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele comenzar con https://cloud.mongodb.com/api/atlas.
- Resultados arreglo[objeto] Requerido
  
  Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.
  
  Ocultar los atributos de resultados Mostrar los atributos de los resultados Objeto
  
  azureLinkId string
  
  ID de enlace que identifica la conexión de terminal privada de Azure.
  
  comment string
  
  Cadena legible por personas para asociar con este nodo privado.
  
  customerEndpointDNSName string
  
  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.
  
  customerEndpointIPAddress string
  
  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}$.
  
  endpointId string Requerido
  
  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}.
  
  Configura nodos privados pa...
  
  mensaje de error string
  
  Mensaje de error que describe un fallo al aprobar la solicitud de nodo privado.
  
  Proveedor string
  
  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.
  
  region string
  
  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 string
  
  Estado de la solicitud de conexión de nodos privados.
  
  Los valores son PENDING, OK, FAILED o DELETING.
  
  tipo string
  
  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.
- totalCount integer(int32)
  
  Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount está configurado en false. El número total es una estimación y puede no ser exacto.
  
  El valor mínimo es 0.
400 application/json

Solicitud incorrecta.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecta.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Describe todas las infracciones en una solicitud de cliente.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de la solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  El código de error de la aplicación se devuelve con este error.
- Parámetros arreglo[objeto]
  
  Parámetros utilizados para proporcionar más información sobre el error.
- motivo string
  
  El mensaje de error de la aplicación se devuelve con este error.
401 application/json

No autorizado.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecta.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Describe todas las infracciones en una solicitud de cliente.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de la solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  El código de error de la aplicación se devuelve con este error.
- Parámetros arreglo[objeto]
  
  Parámetros utilizados para proporcionar más información sobre el error.
- motivo string
  
  El mensaje de error de la aplicación se devuelve con este error.
403 application/json

Forbidden.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecta.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Describe todas las infracciones en una solicitud de cliente.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de la solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  El código de error de la aplicación se devuelve con este error.
- Parámetros arreglo[objeto]
  
  Parámetros utilizados para proporcionar más información sobre el error.
- motivo string
  
  El mensaje de error de la aplicación se devuelve con este error.
404 application/json

No se ha encontrado.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecta.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Describe todas las infracciones en una solicitud de cliente.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de la solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  El código de error de la aplicación se devuelve con este error.
- Parámetros arreglo[objeto]
  
  Parámetros utilizados para proporcionar más información sobre el error.
- motivo string
  
  El mensaje de error de la aplicación se devuelve con este error.
500 application/json

Error interno del servidor.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecta.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Describe todas las infracciones en una solicitud de cliente.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de la solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  El código de error de la aplicación se devuelve con este error.
- Parámetros arreglo[objeto]
  
  Parámetros utilizados para proporcionar más información sobre el error.
- motivo string
  
  El mensaje de error de la aplicación se devuelve con este error.

POST /api/atlas/v1.0/groups/{groupId}/privateNetworkSettings/endpointIds

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"}'

Solicitar ejemplos

{
  "azureLinkId": "string",
  "comment": "string",
  "customerEndpointDNSName": "string",
  "customerEndpointIPAddress": "string",
  "endpointId": "string",
  "errorMessage": "string",
  "provider": "AWS",
  "region": "US_EAST_1",
  "status": "PENDING",
  "type": "DATA_LAKE"
}

Ejemplos de respuesta (201)

{
  "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
}

Ejemplos de respuesta (400)

{
  "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"
}

Ejemplos de respuesta (401)

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

Ejemplos de respuesta (403)

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

Ejemplos de respuesta (404)

{
  "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"
}

Ejemplos de respuesta (500)

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