atlas api

Accede a todas las funcionalidades de la API de administración de Atlas mediante la CLI de Atlas usando el comando 'atlas api <tag> <operationId>'.

Esta funcionalidad agiliza el desarrollo de scripts, permitiéndote interactuar directamente con cualquier endpoint de la API de administración de Atlas a través de la Atlas CLI.

Para obtener más información sobre - API de Administración de Atlas, consulta: https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/ - Introducción a la API de administración de Atlas: https://www.mongodb.com/es/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access

El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.

Sintaxis

Sintaxis del comando

atlas api <tag> <operationId> [options]

Importante

Ambos <tag> y <operationId> deben estar en camelCase.

Arguments

Nombre	Tipo	Requerido	Descripción
<tag>	string	true	La categoría de operaciones de la API de Administración de Atlas en camelCase. Para encontrar y formatear la etiqueta, consulte la URL de la documentación de la API para el punto final. Aparece después `#tag/` de, pero debe cambiar a camelCase. Para consultar la documentación de la API de Atlas, consulte: https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/. Por ejemplo, en `https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs`, la etiqueta es `Monitoring-and-Logs`. En camelCase, es `monitoringAndLogs`.
<operationId>	string	true	El identificador del punto final de la API de administración de Atlas en camelCase. Para encontrar el operationId, consulta la URL de la documentación de la API para el endpoint. Aparece después de `operation/`. Para la documentación de la API de Atlas, consulta: https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/. Por ejemplo, en `https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-listclusters`, el operationId es `listClusters`.

Opciones de subcomando

Pase la ruta y los parámetros de consulta del punto final de la API de administración de Atlas como indicadores. Por ejemplo, si el punto final es /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}, el comando CLI de Atlas es:

atlas api <tag> <operationId> --orgId <ORG_ID> --invoiceId <INVOICE_ID>

Nota

Por lo general, no necesitas especificar --orgId y --projectId ya que se obtienen de tu perfil. Especifícalos sólo si no están configurados en tu perfil.

Si aplica al endpoint, envía el cuerpo de la solicitud usando la opción --file o la entrada estándar (stdin). Por ejemplo:

atlas api clusters create --file cluster-config.json

Además, las siguientes opciones están disponibles para todos los puntos finales de la API de administración de Atlas.

Nombre	Tipo	Requerido	Descripción
`--api-version`	string	false	Especifique la versión de la API de administración de Atlas para el comando. El valor predeterminado es la última versión de la API o el valor que haya configurado para `api_version` en su perfil.
`--out`	string	false	Formato de salida. El valor por defecto es `json`, pero los formatos admitidos pueden variar según el endpoint: La mayoría de los endpoints devuelven `json`. Cuando se admite `json`, también puedes usar una plantilla Go (Go template). Algunos endpoints admiten `json` y `csv`, lo que te permite usar `json`, `csv` o una plantilla Go. Algunos endpoints generan datos binarios (por ejemplo, registros en formato gzip), lo que requiere la opción `--out`. Para determinar los formatos admitidos para un endpoint: Consulta ejemplos del tipo de respuesta de contenido en la documentación de la API: https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/. Ejecuta `atlas api <tag> <operationId> --help` para obtener detalles.
`-o, --out-file`	string	false	Ruta de archivo para guardar la salida. Por defecto, el resultado se muestra en el terminal.
`--file`	string	false	Ruta del archivo al contenido del cuerpo de la solicitud, si la operación lo requiere. Como alternativa, proporcione la entrada mediante la entrada estándar (`stdin`).
`-h, --help`	booleano	false	Ayuda para el comando actual.

opciones

Nombre	Tipo	Requerido	Descripción
-h, --help		false	ayuda para api

Opciones heredadas

Nombre	Tipo	Requerido	Descripción
-P, --profile	string	false	Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Comandos relacionados

atlas api accessTracking: devuelve registros de acceso de los intentos de autenticación realizados en las implementaciones de bases de datos Atlas.
atlas api aiModels: devuelve, agrega, edita y elimina claves API y límites de velocidad para sus modelos de IA.
atlas api alertConfigurations - Devuelve y edita las condiciones que activan alertas y cómo MongoDB nube notifica a los usuarios.
alertas de atlas api: devuelve y reconoce alertas que MongoDB Cloud activa en función de las condiciones de alerta que se definen.
Atlas API atlasSearch - Devuelve, añade, edita y remueve índices de Atlas Search para el clúster especificado.
Auditoría de API de Atlas: devuelve y edita configuraciones de auditoría de bases de datos para proyectos de MongoDB Cloud.
atlas api awsClustersDns – Devuelve y edita configuraciones DNS personalizadas para implementaciones de bases de datos MongoDB en la nube en AWS.
atlas api cloudBackups - Gestiona instantáneas de copias de seguridad en la nube, cubos de exportación de instantáneas, tareas de restauración y cronogramas.
atlas api cloudMigrationService - Administra el Servicio de migración a la nube.
atlas api cloudProviderAccess - Devuelve, agrega, autoriza y remover roles de IAM de AWS en Atlas.
atlas api clusterOutageSimulation - Devuelve, inicia o finaliza una simulación de Interrupción del servicio de clústeres.
Atlas API clústeres - Devuelve, agrega, edita y remueve implementaciones de la base de datos.
atlas api collectionLevelMetrics: devuelve, agrega y edita espacios de nombres anclados para el clúster o proceso especificado.
Atlas API customDatabaseRoles - Devuelve, agrega, edita y remueve roles personalizados de privilegios de usuario de base de datos.
atlas api dataFederation: devuelve, agrega, edita y elimina instancias de bases de datos federadas.
atlas api databaseUsers - Devuelve, agrega, edita y remueve usuarios de base de datos.
atlas api encryptionAtRestUsingCustomerKeyManagement - Retorna y edita la configuración de cifrado en reposo utilizando la gestión de claves del cliente.
eventos de la API de Atlas: devuelve eventos.
atlas api federatedAuthentication - Devuelve, añade, edita y remueve funcionalidades relacionadas con federaciones, como asignaciones de roles y configuraciones de organizaciones conectadas.
atlas api flexClusters - Devuelve, añade, edita y remueve clústeres flex.
atlas api flexRestoreJobs - Devuelve y añade trabajos de restauración para despliegues de bases de datos flex.
atlas api flexSnapshots: Devoluciones y solicitudes para descargar snapshots de la implementación de la base de datos Flex.
Atlas API clúster global - Devuelve, agrega y elimina los namespaces gestionados de clúster global y los mapeos de zonas personalizados.
Facturas de la API de Atlas: devuelve facturas.
atlas api ldapConfiguration - Devuelve, edita, verifica y remueve configuraciones LDAP.
atlas api maintenanceWindows: devuelve, edita y elimina ventanas de mantenimiento.
atlas api mongoDbCloudUsers - Devuelve, añade y edita usuarios de MongoDB Cloud.
atlas api monitoringAndLogs: devuelve datos de registro y monitoreo de implementación de base de datos.
atlas api networkPeering - Devuelve, añade, modifica y remueve contenedores de network peering y conexiones de emparejamiento.
Atlas API onlineArchive - Devuelve, añade, edita o remueve un fichero en línea.
Organizaciones de la API de Atlas: devuelve, agrega y edita unidades organizativas en MongoDB Cloud.
atlas api performanceAdvisor: devuelve índices sugeridos y datos de consultas lentas para una implementación de base de datos.
atlas api privateEndpointServices - Devuelve, agrega, edita y remueve servicios de endpoint privados.
atlas api programmaticApiKeys - Devuelve, añade, edita y elimina tokens de acceso para utilizar la API de MongoDB nube.
atlas API projectIpAccessList - Devuelve, agrega, edita y remueve los límites de acceso a la red a las implementaciones de la base de datos en Atlas.
atlas api Proyectos : Devuelve, agrega y edita colecciones de clústeres y usuarios en MongoDB nube.
atlas api pushBasedLogExport - Puedes exportar continuamente mongod, mongos y registros de auditoría a un bucket de AWS S3.
atlas api queryShapeInsights -
atlas api resourcePolicies: configure y administre las políticas de recursos de Atlas dentro de su organización.
Atlas API rollingIndex - Crea un índice para una implementación de la base de datos de manera incremental.
atlas api root: devuelve detalles que describen la compilación de MongoDB Cloud y el token de acceso que solicita este recurso.
atlas api serviceAccounts - Puntos finales para gestionar Cuentas de Servicio y secretos.
atlas api streams: devuelve, agrega, edita y elimina espacios de trabajo de Streams.
equipos de la API de Atlas - Devolver, agregar, editar o remover equipos.
atlas api thirdPartyIntegrations - Devuelve, agrega, edita y remueve configuraciones de integración de servicios de terceros.
509Autenticación de Atlas API X: devuelve, edita y elimina509 configuraciones X. administradas por el usuario.

Volver

invitar a

Seguimiento de acceso