Acceda a todas las funciones de la API de administración de Atlas a través de la CLI de Atlas usando el comando 'atlas api <tag> <operationId>'.
Esta función agiliza el desarrollo de scripts al permitirle interactuar directamente con cualquier punto final de la API de administración de Atlas a través de la CLI de Atlas.
Para obtener más información sobre la API de administración de Atlas, consulte: 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
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 Por ejemplo, en |
<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 Por ejemplo, en |
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 corresponde al punto final, pase el cuerpo de la solicitud mediante 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 |
|---|---|---|---|
| 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 |
| string | false | Formato de salida. El valor predeterminado es
Para determinar los formatos admitidos para un endpoint:
|
| string | false | Ruta del archivo donde se guarda el resultado. Por defecto, el resultado se muestra en la terminal. |
| 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 ( |
| 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 usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte 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.
Fuente de actividad de laAPI de 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 Cloud notifica a los usuarios.
Alertas de API de Atlas: devuelve y reconoce las alertas que MongoDB Cloud activa según las condiciones de alerta que usted defina.
atlas api atlasSearch: devuelve, agrega, edita y elimina índices de búsqueda de Atlas 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 de DNS personalizadas para implementaciones de bases de datos de MongoDB Cloud en AWS.
atlas api cloudBackups: administra instantáneas de Cloud Backup, depósitos de exportación de instantáneas, trabajos de restauración y programaciones.
atlas api cloudMigrationService: administra el servicio de migración a la nube.
atlas api cloudProviderAccess: devuelve, agrega, autoriza y elimina roles de AWS IAM en Atlas.
atlas api clusterOutageSimulation: devuelve, inicia o finaliza una simulación de interrupción del clúster.
Atlas API Clusters: devuelve, agrega, edita y elimina implementaciones de bases 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 elimina roles de privilegios de usuario de base de datos personalizados.
atlas api dataFederation: devuelve, agrega, edita y elimina instancias de bases de datos federadas.
atlas api databaseUsers: devuelve, agrega, edita y elimina usuarios de la base de datos.
atlas api encryptionAtRestUsingCustomerKeyManagement: devuelve y edita la configuración de cifrado en reposo mediante la administración de claves del cliente.
eventos de la API de Atlas: devuelve eventos.
atlas api federatedAuthentication: devuelve, agrega, edita y elimina funciones relacionadas con la federación, 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: devuelve y solicita descargar instantáneas de implementación de base de datos flexible.
atlas api globalClusters: devuelve, agrega y elimina espacios de nombres administrados por clústeres globales y asignaciones de zonas personalizadas.
facturas atlas api - Devuelve facturas.
atlas api ldapConfiguration: devuelve, edita, verifica y elimina configuraciones LDAP.
atlas api maintenanceWindows: devuelve, edita y elimina ventanas de mantenimiento.
atlas api mongoDbCloudUsers: devuelve, agrega 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, agrega, edita y elimina contenedores y conexiones de intercambio de redes.
atlas api onlineArchive: devuelve, agrega, edita o elimina un archivo 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 elimina servicios de puntos finales privados.
atlas api programmaticApiKeys: devuelve, agrega, edita y elimina tokens de acceso para usar la API de MongoDB Cloud.
Proyecto de API de AtlasIpAccessList: devuelve, agrega, edita y elimina los límites de acceso a la red para las implementaciones de bases de datos en Atlas.
Proyectos de API de Atlas: devuelve, agrega y edita colecciones de clústeres y usuarios en MongoDB Cloud.
atlas api pushBasedLogExport: puede exportar continuamente registros de mongod, mongos y auditoría a un3 bucket de AWS S.
consultade API de AtlasShapeInsights -
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 base de datos de manera continua.
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 administrar cuentas de servicio y secretos.
atlas api streams: devuelve, agrega, edita y elimina espacios de trabajo de Streams.
Equipos de la API de Atlas: devuelve, agrega, edita o elimina equipos.
atlas api thirdPartyIntegrations: devuelve, agrega, edita y elimina configuraciones de integración de servicios de terceros.
509Autenticación de Atlas API X: devuelve, edita y elimina509 configuraciones X. administradas por el usuario.