mon-describe-alarms-for-metric - Amazon CloudWatch

mon-describe-alarms-for-metric

Descripción

Obtiene información sobre las alarmas asociadas a la métrica especificada.

Sintaxis

mon-describe-alarms-for-metric --metric-name value --namespace value [--dimensions "key1=value1,key2=value2..."] [--period value] [--statistic value] [--extendedstatistic value] [--unit value] [Common Options]

Opciones

Nombre Descripción

--dimensions - "key1=value1,key2=value2...

Las dimensiones asociadas con la métrica. Puede especificar dimensiones dos formas y los formatos se pueden combinar o utilizar indistintamente:

  • Una opción por dimensión: --dimensions "key1=value1" --dimensions "key2=value2"

  • Una opción integral: --dimensions "key1=value1,key2=value2"

Tipo: Map

Valores válidos: una cadena con el formato nombre=valor, donde la clave es el nombre de la dimensión y el valor es el valor de la dimensión. Los nombres de dimensión y los valores deben ser una cadena ANSI de entre 1 y 250 caracteres. Se permite un máximo de 10 dimensiones.

Valor predeterminado: n/a

Requerido: No

--metric-name VALUE

El nombre de la métrica cuya alarmas asociados desea buscar.

Tipo: argumento

Valores válidos: un nombre de métrica válido entre 1 y 255 caracteres de longitud.

Valor predeterminado: n/a

Obligatorio: sí

--namespace VALUE

El espacio de nombres de la métrica asociada a la alarma. Para obtener más información acerca de los espacios de nombres, consulte Espacios de nombres de AWS.

Tipo: String

Valores válidos: un espacio de nombres válido de entre 1 y 250 caracteres de longitud.

Valor predeterminado: n/a

Obligatorio: sí

--period VALUE

Periodo por el que se filtran las alarmas. Solo se incluirán en los resultados las alarmas que evalúan métricas en este período. Si esto no se especifica, se incluirán alarmas en cualquier período.

Tipo: argumento

Valores válidos: un número, en segundos que es un múltiplo de 60 segundos.

Valor predeterminado: n/a

Requerido: No

--statistic VALUE

La estadística por la que filtrar las alarmas. Solo se incluirán alarmas en la estadística que se especifique. Si este parámetro no se especifica, se incluyen alarmas en cualquier estadística.

Tipo: enumeración

Valores válidos: SampleCount, Average, Sum, Minimum o Maximum

Valor predeterminado: n/a

Requerido: No

--extendedstatistic VALUE

La estadística de percentiles por la que filtrar las alarmas. Solo se incluyen alarmas en la estadística que se especifique. Si este parámetro no se especifica, se incluyen alarmas en cualquier estadística.

Tipo: String

Valores válidos: cualquier percentil con hasta dos decimales (por ejemplo, p95.45).

Valor predeterminado: n/a

Requerido: No

--unit VALUE

La unidad con la que filtrar las alarmas. Solo se incluirán alarmas en las estadísticas especificadas. Si esto no se especifica, se incluirán alarmas en cualquier unidad. Si la alarma no tiene una unidad especificada, la única forma de buscar la alarma es omitir esta opción.

Tipo: enumeración

Valores válidos: uno de los siguientes:

  • Segundos

  • Microsegundos

  • Milisegundos

  • Bytes

  • Kilobytes

  • Megabytes

  • Gigabytes

  • Terabytes

  • Bits

  • Kilobits

  • Megabits

  • Gigabits

  • Terabits

  • Porcentaje

  • Recuento

  • Bytes/segundo

  • Kilobytes/segundo

  • Megabytes/segundo

  • Gigabytes/segundo

  • Terabytes/segundo

  • Bits/segundo

  • Kilobits/segundo

  • Megabits/segundo

  • Gigabits/segundo

  • Terabits/segundo

  • Recuento/segundo

  • Ninguno

Valor predeterminado: n/a

Requerido: 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: String

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: String

Valores válidos: una ruta de archivo válida al archivo PEM que Amazon EC2 o AWS Identity and Access Management proporcionan.

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.

Predeterminado: 30

--delimiter VALUE

El delimitador que se va a utilizar al mostrar resultados delimitados (largos).

Tipo: String

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: String

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: String

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: String

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: String

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

Valor 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: String

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.

Salida

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_REASON: Una razón para el estado de lectura humana. Esta columna solo aparece en la vista --show-long.

  • STATE_REASON_DATA: 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_ACTIONS: La acción que se va a ejecutar en el estado OK. Esta columna solo aparece en la vista --show-long.

  • ALARM_ACTIONS: La acción que se ejecuta en el estado de ALARMA.

  • INSUFFICIENT_DATA_ACTIONS: La acción que se va a ejecutar en el estado INSUFICIENT_DATA (datos insuficientes). Esta columna solo aparece en la vista --show-long.

  • ESPACIO DE NOMBRES: Espacio de nombres para la métrica.

  • METRIC_NAME: 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_PERIODS: 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 describe una alarma para una métrica concreta.

mon-describe-alarms-for-metric--metric-name CPUUtilization --namespace AWS/EC2 --dimensions InstanceId=i-abcdef

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 80.0

Temas relacionados

Descargar

Acción relacionada

Comandos relacionados