Cree una instancia de base de datos federada y un punto final privado de archivo en línea para un proyecto
Añade un punto de conexión privado para las Instancias de Bases de Datos Federadas y los Archivos en Línea a los proyectos especificados. Si el ID del punto de conexión ya existe y el comentario asociado no se modifica, Atlas Data Federation no realiza cambios en la lista de ID de puntos de conexión. Si el ID del punto de conexión ya existe y el comentario asociado se modifica, Atlas Data Federation actualiza el valor del comentario solo en la lista de ID de puntos de conexión. Si el ID del punto de conexión no existe, Atlas Data Federation añade el nuevo punto de conexión a la lista de ID de puntos de conexión. Cada región tiene un nombre de servicio asociado para los distintos puntos de conexión de 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.
Para utilizar este recurso, la cuenta de servicio o la clave API solicitante deben tener los roles de propietario del proyecto o administrador de gráficos del proyecto.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula 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 solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
Cuerpo
Requerido
Punto final privado para instancias de bases de datos federadas y archivos en línea para agregar al proyecto especificado.
-
ID de vínculo que identifica la conexión del punto de conexión privado de Azure.
-
Cadena legible por humanos para asociar con este punto final privado.
-
Etiqueta legible para identificar el nombre DNS del punto final de la VPC del cliente. Si se define, también debe especificar un valor para
region. -
Dirección IP utilizada para conectarse 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}$. -
Cadena alfanumérica única de 22caracteres que identifica el punto final privado.
El formato debe coincidir con el siguiente patrón:
^vpce-[0-9a-f]{17}$.Atlas Data Lake es compatible con Amazon... -
Mensaje de error que describe una falla al aprobar la solicitud de punto final privado.
-
Etiqueta legible que identifica al proveedor de servicios en la nube. Atlas Data Lake solo es compatible con Amazon Web Services.
El valor es
AWS. El valor predeterminado esAWS. -
Etiqueta legible para identificar la región del punto final de la VPC del cliente. Si se define, también debe especificar un valor para
customerEndpointDNSName. -
Estado de la solicitud de conexión del punto final privado.
Los valores son
PENDING,OK,FAILEDoDELETING. -
Etiqueta legible por humanos que identifica el tipo de recurso asociado con este punto final privado.
El valor es
DATA_LAKE. El valor predeterminado esDATA_LAKE.
atlas api dataFederation createPrivateEndpointId --helpimport (
"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.CreateGroupPrivateNetworkSettingEndpointIdApiParams{}
sdkResp, httpResp, err := client.DataFederationApi.
CreateGroupPrivateNetworkSettingEndpointIdWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \
-d '{ <Payload> }'{
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"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": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}
],
"totalCount": 42
}{
"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"
}