Devuelve los detalles de las configuraciones de alerta especificadas para tu proyecto.
Para utilizar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con la función de solo lectura del proyecto.
Sintaxis
atlas alerts settings describe <alertConfigId> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
alertConfigId | string | true | Identificador único de la configuración de alertas que deseas describir. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-h, --ayuda | false | ayuda para describir | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
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 para la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
ID TYPE ENABLED <Id> <EventTypeName> <Enabled>
Ejemplos
# Return the JSON-formatted details for the alert settings with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: atlas alerts settings describe 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json