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/ - Comenzar con 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 del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.
Sintaxis
atlas api <tag> <operationId> [options]
Importante
Ambos <tag> y <operationId> debe estar en camelCase.
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
<tag> | string | true | La categoría de las operaciones de la API de administración de Atlas en camelCase. Para encontrar y formatear la etiqueta, revisa la URL de la documentación de la API del endpoint. Aparece después de Por ejemplo, en |
<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 Por ejemplo, en |
Opciones de subcomando
Pasa la ruta y los parámetros de consulta para el endpoint de la API de Administración de Atlas como banderas. Por ejemplo, si el endpoint es /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}, el comando de la Atlas CLI 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 |
|---|---|---|---|
| string | false | Especifique la versión de la API de administración de Atlas para el comando. Por defecto, utiliza la última versión de la API o el valor que hayas configurado para |
| string | false | Formato de salida. El valor por defecto es
Para determinar los formatos admitidos para un endpoint:
|
| string | false | Ruta de archivo para guardar la salida. Por defecto, el resultado se muestra en el terminal. |
| string | false | Ruta de archivo al contenido del cuerpo de la solicitud, si la operación la requiere. Alternativamente, proporcionar la entrada a través de la entrada estándar ( |
| 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 los registros de acceso de los intentos de autenticación realizados en las implementaciones de bases de datos Atlas.
api aiModels atlas - Devuelve, agregue, edite y elimine 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 la API de Atlas - Devuelve y edita la configuración 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 fijados 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 remueve Instancias de Base 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 remueve períodos de mantenimiento.
atlas api mongoDbCloudUsers - Devuelve, añade y edita usuarios de MongoDB Cloud.
Atlas API monitoringAndLogs - Devuelve datos de supervisión y registro de la implementación de la 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 nube.
Atlas API performanceAdvisor - Devuelve índices sugeridos y datos de consultas lentas para una implementación de la 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 resourcePolicies - Configura y gestiona las políticas de recursos de Atlas dentro de tu organización.
Atlas API rollingIndex - Crea un índice para una implementación de la base de datos de manera incremental.
raíz de Atlas API : devuelve detalles que describen la compilación de MongoDB nube y el token de acceso que solicita este recurso.
atlas api serviceAccounts - Puntos finales para gestionar Cuentas de Servicio y secretos.
flujos de la API de Atlas - Devuelve, agrega, edita y remover espacios de trabajo de flujos.
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.
atlas api x509autenticación - Devuelve, edita y remueve las configuraciones de X.509 gestionadas por el usuario.