# mon-describe-alarms ## Descripción Obtiene información acerca de las alarmas especificadas. Si no especifica un nombre de alarma, este comando devuelve informaciones sobre todas las alarmas. Puede recuperar alarmas utilizando únicamente el prefijo de nombre de alarma, el estado de alarma o un prefijo de acción. ## Sintaxis ****mon-describe-alarms** [AlarmNames [*AlarmNames* ...]] [--action-prefix *value*] [--alarm-name-prefix *value*] [--state-value *value*] [Common Options]** ## Opciones | Nombre | Descripción | | --- | --- | | `AlarmNames` `AlarmNames` | Los nombres de las alarmas. Puede establecer también este valor mediante : `--alarm-name`. Puedes especificar esta opción varias veces. Tipo: argumento Valores válidos: un nombre de alarma existente; de lo contrario, no se devuelve ninguna respuesta. Valor predeterminado: n/d, muestra todas las alarmas de forma predeterminada. Obligatorio: no | | `--action-prefix` `VALUE` | Prefijo de nombres de acción. Tipo: argumento Valores válidos: el prefijo de un nombre de acción existente, en formato de ARN. Valor predeterminado: n/d, muestre la primera acción de forma predeterminada. Obligatorio: no | | `--alarm-name-prefix` `VALUE` | Prefijo de nombres de alarma. Tipo: argumento Valores válidos: el prefijo de un nombre de alarma existente. Valor predeterminado: n/a Obligatorio: no | | `--state-value` `VALUE` | El estado de la alarma. Tipo: enumeración Valores válidos: OK, ALARM o INSUFFICIENT\$1DATA Valor predeterminado: Todos los estados de alarma. Obligatorio: no | ## Opciones comunes | Nombre | Descripción | | --- | --- | | `--aws-credential-file` `VALUE` | La ubicación del archivo de credenciales de AWS. Puede establecer este valor mediante la variable de entorno `AWS_CREDENTIAL_FILE`. Si define la variable de entorno o proporciona la ruta de acceso al archivo de credenciales, el archivo debe existir o, de lo contrario, se produce un error en la solicitud. Las solicitudes de CloudWatch deben firmarse con un ID de clave de acceso y una clave de acceso secreta. Tipo: cadena Valores válidos: Ruta de acceso válida de un archivo que contenga el ID de clave de acceso y la clave de acceso secreta. Valor predeterminado: Utiliza la variable de entorno `AWS_CREDENTIAL_FILE`, si se establece. | | `-C, --ec2-cert-file-path` `VALUE` | La ubicación del archivo del certificado EC2 para las solicitudes de firma. Puede utilizar la variable de entorno `EC2_CERT` para especificar este valor. Tipo: cadena Valores válidos: una ruta de archivo válida al archivo PEM que Amazon EC2 o proporcionan AWS Identity and Access Management. Valor predeterminado: Utiliza la variable de entorno `EC2_CERT`, si se establece. | | `--connection-timeout` `VALUE` | El valor del tiempo de espera de la conexión en segundos. Tipo: número entero Valores válidos: Cualquier número positivo. Valor predeterminado: 30 | | `--delimiter` `VALUE` | El delimitador que se va a utilizar al mostrar resultados delimitados (largos). Tipo: cadena Valores válidos: Cualquier cadena. Valor predeterminado: Coma (,) | | `--headers` `` | Si muestra resultados tabulares o delimitados, incluya las cabeceras de columna. Si muestra resultados XML, devuelva las cabeceras HTTP de la solicitud de servicio, si corresponde. Tipo: marca Valores válidos: Cuando hay, muestra cabeceras. Valor predeterminado: La opción `--headers` está deshabilitada de forma predeterminada. | | `-I, --access-key-id` `VALUE` | El ID de clave de acceso que se utilizará, en combinación con la clave secreta, para firmar la solicitud. Esto se debe utilizar en combinación con la clave secreta, de lo contrario, se ignora la opción. Todas las solicitudes a CloudWatch deben estar firmadas; de lo contrario, la solicitud se rechaza. Tipo: cadena Valores válidos: Un ID de clave de acceso válido. Valor predeterminado: none | | `-K, --ec2-private-key-file-path` `VALUE` | La clave privada que se va a utilizar para firmar la solicitud. El uso de claves públicas o privadas hace que la CLI utilice SOAP. La solicitud se firma con un certificado público y una clave privada. Este parámetro se debe usar junto con `EC2_CERT`, de lo contrario, el valor no se tiene en cuenta. El valor de la variable de entorno `EC2_PRIVATE_KEY` se usará si está configurado, y esta opción no está especificada. Esta opción se pasa por alto si la variable de entorno `AWS_CREDENTIAL_FILE` está establecida, o se utiliza `--aws-credentials-file`. Todas las solicitudes a CloudWatch deben estar firmadas; de lo contrario, la solicitud se rechaza. Tipo: cadena Valores válidos: Ruta de acceso a una clave privada ASN.1 válida. Valor predeterminado: none | | `--region` `VALUE` | Las solicitudes de región se dirigen a. Puede utilizar la variable de entorno `EC2_REGION` para especificar el valor. La región se utiliza para crear la URL que se utiliza para llamar a CloudWatch, y debe ser una Región (de AWS) válida de Amazon Web Services. Tipo: cadena Valores válidos: Cualquier Región de AWS, por ejemplo, us-east-1. Valor predeterminado: us-east-1, a menos que la variable de entorno `EC2_REGION` esté establecida. | | `S, --secret-key` `VALUE` | La clave de acceso secreta que se utilizará para firmar la solicitud, junto con un ID de clave de acceso. Este parámetro se debe usar junto con `--access-key-id`, de lo contrario, la opción no en tiene en cuenta. Tipo: cadena Valores válidos: ID de clave de acceso. Valor predeterminado: none | | `--show-empty-fields` `` | Muestra campos vacíos al utilizar (nulo) como espacio disponible para indicar que no se solicitaron estos datos. Tipo: marca Valores válidos: Ninguno Valor predeterminado: Los campos vacíos no se muestran de forma predeterminada. | | `--show-request` `` | Muestra la URL que utiliza la CLI para llamar a AWS. Tipo: marca Valores válidos: Ninguno Predeterminado: false | | `--show-table, --show-long, --show-xml, --quiet` `` | Especifica cómo se muestran los resultados: en una tabla, delimitados (largos), XML o sin salida (silenciosos). La pantalla `--show-table` muestra un subconjunto de los datos en forma de ancho de columna fija; `--show-long` muestra todos los valores devueltos delimitados por un carácter; `--show-xml` es el retorno sin procesar del servicio; y `--quiet` suprime toda la salida estándar. Todas las opciones son mutuamente excluyentes, con la prioridad `--show-table`, `--show-long`, `--show-xml` y `--quiet`. Tipo: marca Valores válidos: Ninguno Valor predeterminado: `--show-table` | | `-U, --url` `VALUE` | La dirección URL que se utiliza para contactarse con CloudWatch. Puede establecer este valor mediante la variable de entorno `AWS_CLOUDWATCH_URL`. Este valor se usa en combinación con `--region` para crear la URL esperada. Esta opción anula la dirección URL de la llamada de servicio. Tipo: cadena Valores válidos: Una dirección HTTP o HTTPS válida. Valor predeterminado: utiliza el valor que se especifica en `AWS_CLOUDWATCH_URL`, si se establece. | ## Output Este comando devuelve una tabla que contiene lo siguiente: + ALARMA: Nombre de la alarma. + DESCRIPCIÓN: Descripción de la alarma. Esta columna solo aparece en la vista --show-long. + ESTADO: Estado de la alarma. + STATE\$1REASON: Una razón para el estado de lectura humana. Esta columna solo aparece en la vista --show-long. + STATE\$1REASON\$1DATA: Una razón de estado de lectura por máquina (formato JSON). Esta columna solo aparece en la vista --show-long. + HABILITAR: Habilita o deshabilita acciones. Esta columna solo aparece en la vista --show-long. + OK\$1ACTIONS: La acción que se va a ejecutar en el estado OK. Esta columna solo aparece en la vista --show-long. + ALARM\$1ACTIONS: La acción que se ejecuta en el estado de ALARMA. + INSUFFICIENT\$1DATA\$1ACTIONS: La acción que se va a ejecutar en el estado INSUFICIENT\$1DATA (datos insuficientes). Esta columna solo aparece en la vista --show-long. + ESPACIO DE NOMBRES: Espacio de nombres para la métrica. + METRIC\$1NAME: Nombre del espacio de nombres de la métrica. + DIMENSIONES: Dimensiones métricas. Esta columna solo aparece en la vista --show-long. + PERÍODO: El período. + ESTADÍSTICA: La estadística (Promedio, Mínimo, Máximo, Suma y Recuento de muestra). + ESTADÍSTICA EXTENDIDA: Estadística del percentil. + UNIDAD: La unidad. Esta columna solo aparece en la vista --show-long. + EVAL\$1PERIODS: Número de períodos para evaluar la métrica. + COMPARACIÓN: El operador de comparación. + UMBRAL: El umbral. La CLI de Amazon CloudWatch muestra errores en stderr. ## Ejemplos ### Ejemplo de solicitud En este ejemplo se describen todas sus alarmas cuyo nombre comienza con my-alarm. ``` mon-describe-alarms --alarm-name-prefix my-alarm --headers ``` Este es un ejemplo de resultado de este comando. ``` ALARM STATE ALARM_ACTIONS NAMESPACE METRIC_NAME PERIOD STATISTIC EVAL_PERIODS COMPARISON THRESHOLD my-alarm1 OK arn:aws:sns:.. AWS/EC2 CPUUtilization 60 Average 3 GreaterThanThreshold 100.0 my-alarm2 OK arn:aws:sns:.. AWS/EC2 CPUUtilization 60 Average 5 GreaterThanThreshold 80o.0 ``` ## Temas relacionados ### Descargar + [Configurar la interfaz de línea de comandos](SetupCLI.md) ### Acción relacionada + [DescribeAlarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) ### Comandos relacionados + [mon-describe-alarm-history](cli-mon-describe-alarm-history.md) + [mon-describe-alarms-for-metric](cli-mon-describe-alarms-for-metric.md)