Crea un servicio de extremo privado para el proveedor de servicios en la nube especificado. Este proveedor de servicios de nube gestiona el servicio de nodos privados para el Proyecto. Cuando creas un servicio de nodos privados, MongoDB Cloud crea un contenedor de red en el Proyecto para el proveedor de nube para el que creas el servicio de nodos privados, si no existe uno ya. Para obtener más información sobre la terminología de nodos privados en MongoDB Cloud, consulta Conceptos de Private Endpoint. Para usar este recurso, la Cuenta de servicio o la Clave API que hace la solicitud debe tener el rol de Propietario del proyecto.
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})$.
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
Cuerpo
Requerido
Crea un endpoint privado para el proveedor de servicios en la nube especificado.
-
Indicador que señala si este servicio de punto final utiliza la asignación de puertos PSC. Esto solo es aplicable para los Servicios de nodos privados de GCP.
El valor por defecto es
false. -
Etiqueta legible por humanos que identifica al proveedor de servicios en la nube para el que se desea crear el servicio de punto final privado.
Los valores son
AWS,AZUREoGCP. -
Región del proveedor de nube en la que deseas crear el servicio de endpoint privado. Las regiones aceptadas como valores difieren para Amazon Web Services, Google Cloud Platform y Microsoft Azure.
-
Lista de regiones compatibles con el servicio de punto final. La compatibilidad nativa entre regiones solo está implementada para AWS.
No más de
35elementos.
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateEndpoint/endpointService' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"portMappingEnabled":false,"providerName":"AWS","region":"string","supportedRemoteRegions":["string"]}'{
"portMappingEnabled": false,
"providerName": "AWS",
"region": "string",
"supportedRemoteRegions": [
"string"
]
}{
"cloudProvider": "AWS",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"regionName": "string",
"status": "INITIATING",
"endpointServiceName": "string",
"interfaceEndpoints": [
"32b6e34b3d91647abb20e7b8"
],
"supportedRemoteRegions": [
"string"
]
}{
"cloudProvider": "AZURE",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"regionName": "string",
"status": "INITIATING",
"privateEndpoints": [
"string"
],
"privateLinkServiceName": "string",
"privateLinkServiceResourceId": "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de"
}{
"cloudProvider": "GCP",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"regionName": "string",
"status": "INITIATING",
"endpointGroupNames": [
"string"
],
"portMappingEnabled": true,
"serviceAttachmentNames": [
"string"
]
}{
"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"
}