atlas api

Accede a todas las funcionalidades de la API de administración de Atlas a través de la Atlas CLI utilizando la atlas api dominio.

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, consulte:

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

Tanto <tag> como <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 formato camelCase. Para encontrar el operationId, consulte la URL de la documentación de la API correspondiente. Aparece después `operation/` de. 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/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

Normalmente no es necesario especificar --orgId ni --projectId, ya que provienen de tu perfil. Indícalos solo 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 predeterminado es `json`, pero los formatos admitidos pueden variar según el punto final: La mayoría de los puntos finales generan `json`. Si se admite `json`, también se puede usar una plantilla de Go. Algunos puntos finales admiten `json` y `csv`, lo que le permite utilizar `json`, `csv` o una plantilla Go. Ciertos puntos finales generan datos binarios (por ejemplo, registros en formato gzip), lo que requiere la opción `--out`. Para determinar los formatos admitidos para un endpoint: Consulte los ejemplos de tipos de respuesta de contenido en la documentación de la API: https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/. Ejecute `atlas api <tag> <operationId> --help` para obtener más detalles.
`-o, --out-file`	string	false	Ruta del archivo donde se guarda el resultado. Por defecto, el resultado se muestra en la 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, --ayuda		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

Seguimiento de acceso de la API de Atlas: vista previa pública: proporcione comentarios: Devuelve registros de acceso para los intentos de autenticación realizados en las implementaciones de bases de datos de Atlas.
atlas api alertConfigurations - Vista previa pública: proporcione comentarios: Devuelve y edita las condiciones que activan alertas y cómo MongoDB Cloud notifica a los usuarios.
atlas api alerts - Vista previa pública: por favor, proporciona comentarios: Devuelve y reconoce alertas que MongoDB nube activa según las condiciones de alerta que definas.
API deAtlas atlasSearch - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina índices de búsqueda de Atlas para el clúster especificado.
Auditoría de API de Atlas: vista previa pública: proporcione comentarios: Devuelve y edita configuraciones de auditoría de base de datos para proyectos de MongoDB Cloud.
atlas api awsClustersDns - Vista previa pública: proporcione comentarios: Devuelve y edita configuraciones de DNS personalizadas para implementaciones de bases de datos de MongoDB Cloud en AWS.
atlas api cloudBackups - Vista previa pública: envíe sus comentarios: administra instantáneas de Cloud Backup, depósitos de exportación de instantáneas, trabajos de restauración y programaciones.
atlas api cloudMigrationService - Vista preliminar pública: por favor, proporciona tus comentarios: Gestiona el servicio de migración a la nube.
atlas api cloudProviderAccess - Vista previa pública: proporcione comentarios: Devuelve, agrega, autoriza y elimina roles de AWS IAM en Atlas.
atlas api clusterOutageSimulation - Vista previa pública: por favor, proporcione su opinión: Devuelve, inicia o termina una simulación de Interrupción del servicio de clúster.
Clústeres de API de Atlas: vista previa pública: proporcione comentarios: devuelve, agrega, edita y elimina implementaciones de bases de datos.
atlas api collectionLevelMetrics - Vista previa pública: por favor, proporciona tus comentarios: Devuelve, añade y edita los espacios de nombres anclados para el clúster o proceso especificado.
atlas api customDatabaseRoles - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina roles de privilegios de usuario de base de datos personalizados.
atlas api dataFederation - Vista previa pública: por favor, proporciona comentarios: Devuelve, añade, edita y remueve instancias federadas de bases de datos.
atlas api databaseUsers - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina usuarios de la base de datos.
Atlas API EncryptionAtRestUsingCustomerKeyManagement - Vista previa pública: proporcione comentarios: Devuelve y edita la configuración de Encryption at Rest usando Customer Key Management.
Eventos de la API de Atlas: vista previa pública: proporcione comentarios: Devuelve eventos.
Atlas API federatedAuthentication - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina funciones relacionadas con la federación, como asignaciones de roles y configuraciones de organizaciones conectadas.
atlas api flexClusters - Vista pública: por favor, proporciona comentarios: Devuelve, añade, edita y remueve clústeres flexibles.
atlas api flexRestoreJobs - Vista previa pública: proporcione comentarios: Devuelve y agrega trabajos de restauración para implementaciones de bases de datos flexibles.
atlas api flexSnapshots - Vista previa pública: proporcione comentarios: Devoluciones y solicitudes para descargar instantáneas de implementación de base de datos flexible.
atlas api globalClusters - Vista previa pública: Proporcione comentarios: Devuelve, añade y elimina espacios de nombres administrados de clústeres globales y mapeos de zonas personalizados.
Facturas de laAPI de Atlas: vista previa pública: proporcione comentarios: Devuelve facturas.
atlas api ldapConfiguration - Vista previa pública: proporcione comentarios: Devuelve, edita, verifica y elimina configuraciones LDAP.
atlas api legacyBackup - Vista previa pública: proporcione comentarios: Administra instantáneas de Legacy Backup, trabajos de restauración, programaciones y puntos de control.
atlas api maintenanceWindows: Vista preliminar pública: por favor proporciona comentarios: Devuelve, edita y remueve períodos de mantenimiento.
atlas api mongoDbCloudUsers - Vista previa pública: proporcione comentarios: Devuelve, agrega y edita usuarios de MongoDB Cloud.
atlas api monitoringAndLogs - Vista previa pública: proporcione comentarios: Devuelve datos de registro y monitoreo de implementación de base de datos.
atlas api networkPeering - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina contenedores de intercambio de redes y conexiones de intercambio.
atlas api en lineaFichero - Vista pública: por favor comparte tus comentarios: Devuelve, añade, edita o remueve un fichero en linea.
atlas api organizaciones - Vista Previa pública: por favor envía tus comentarios: Devuelve, agrega y edita unidades de organizaciones en MongoDB nube.
atlas api performanceAdvisor - Vista previa pública: proporcione comentarios: Devuelve índices sugeridos y datos de consultas lentas para una implementación de base de datos.
atlas api privateEndpointServices - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina servicios de puntos finales privados.
atlas api programmaticApiKeys - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina tokens de acceso para usar la API de MongoDB Cloud.
atlas api projectIpAccessList - Vista previa pública: se solicita su opinión: Devuelve, agrega, edita y remueve los límites de acceso a la red en las implementaciones de la base de datos en Atlas.
Proyectos de API de Atlas: vista previa pública: proporcione comentarios: Devuelve, agrega y edita colecciones de clústeres y usuarios en MongoDB Cloud.
atlas api pushBasedLogExport - Vista previa pública: Por favor, den su opinión: Puede enviar continuamente registros de mongod, mongos y registros de auditoría a un bucket AWS S3.
API de Atlas queryShapeInsights - Vista previa pública: envíe sus comentarios.
atlas api resourcePolicies - Public Preview: por favor aporte sus comentarios: Configure y gestione las Políticas de recurso de Atlas dentro de su organización.
atlas api rollingIndex - Vista previa pública: por favor proporciona tus comentarios: Crea un índice en una implementación de la base de datos de manera continua.
raíz de la API de Atlas: vista previa pública: proporcione comentarios: Devuelve detalles que describen la compilación de MongoDB Cloud y el token de acceso que solicita este recurso.
atlas api serviceAccounts - Vista pública: por favor, proporcionen comentarios: Endpoints para gestionar Service Accounts y secretos.
atlas api sharedTierRestoreJobs - Vista previa pública: proporcione comentarios: Devuelve y agrega trabajos de restauración para implementaciones de bases de datos de nivel compartido.
atlas api sharedTierSnapshots - Vista previa pública: proporcione comentarios: Devoluciones y solicitudes para descargar instantáneas de implementación de bases de datos de nivel compartido.
atlas api streams - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina instancias de Streams.
atlas api teams - Public Preview: por favor, entreguen sus comentarios: Devuelve, agrega, edita o remueve equipos.
atlas api thirdPartyIntegrations - Vista previa pública: proporcione comentarios: Devuelve, agrega, edita y elimina configuraciones de integración de servicios de terceros.
509Autenticación de Atlas API X: vista previa pública: proporcione comentarios: Devuelve, edita y elimina509 configuraciones X. administradas por el usuario.

Volver

invitar a

Seguimiento de acceso