mon-describe-alarms - Amazon CloudWatch
DescriçãoSintaxeOpçõesOpções comunsSaídaExemplosTópicos relacionados da

mon-describe-alarms

Descrição

Obtém as informações sobre os alarmes especificados. Se você não especificar um nome do alarme, esse comando retornará informações sobre todos os alarmes. Recupere alarmes usando apenas o prefixo do nome do alarme, o estado do alarme ou um prefixo da ação.

Sintaxe

mon-describe-alarms [AlarmNames [AlarmNames ...]] [--action-prefix value] [--alarm-name-prefix value] [--state-value value] [Common Options]

Opções

Nome Descrição

AlarmNames AlarmNames

Os nomes dos alarmes. Também defina esse valor usando --alarm-name. Especifique essa opção várias vezes.

Tipo: argumento

Valores válidos: um nome do alarme existente; do contrário, nenhuma resposta é retornada.

Padrão: n/d, exibe todos os alarmes por padrão.

Obrigatório: Não

--action-prefix VALUE

Prefixo de nomes de ação.

Tipo: argumento

Valores válidos: o prefixo de um nome da ação existente, em formato ARN.

Padrão: n/d, exiba a primeira ação por padrão.

Obrigatório: Não

--alarm-name-prefix VALUE

Prefixo de nomes de alarme.

Tipo: argumento

Valores válidos: o prefixo de um nome do alarme existente.

Padrão: n/d

Obrigatório: Não

--state-value VALUE

O estado do alarme.

Tipo: enumeração

Valores válidos: OK, ALARM ou INSUFFICIENT_DATA

Padrão: todos os estados de alarme.

Obrigatório: Não

Opções comuns

Nome Descrição

--aws-credential-file VALUE

O local do arquivo com suas credenciais da AWS. É possível definir esse valor usando a variável de ambiente AWS_CREDENTIAL_FILE. Se você definir a variável de ambiente ou fornecer o caminho para o arquivo de credenciais, a solicitação falhará caso o arquivo não exista. Todas as solicitações do CloudWatch deverão ser assinadas usando seu ID da chave de acesso e sua chave de acesso secreta.

Tipo: string

Valores válidos: um caminho válido para um arquivo contendo seu ID da chave de acesso e sua chave de acesso secreta.

Padrão: usa a variável de ambiente AWS_CREDENTIAL_FILE, se estiver definida.

-C, --ec2-cert-file-path VALUE

O local do arquivo de certificado do EC2 para solicitações de assinatura. É possível usar a variável de ambiente EC2_CERT para especificar esse valor.

Tipo: string

Valores válidos: um caminho de arquivo válido para o arquivo PEM fornecido pelo Amazon EC2 ou pelo AWS Identity and Access Management.

Padrão: usa a variável de ambiente EC2_CERT, se estiver definida.

--connection-timeout VALUE

O valor de tempo limite de conexão, em segundos.

Tipo: número inteiro

Valores válidos: qualquer número positivo.

Padrão: 30

--delimiter VALUE

O delimitador a ser usado quando são exibidos resultados delimitados (longos).

Tipo: string

Valores válidos: qualquer string.

Padrão: vírgula (,)

--headers

Se estiver exibindo resultados tabulares ou delimitados, inclua os cabeçalhos de coluna. Se estiver exibindo resultados em XML, retorne os cabeçalhos HTTP da solicitação de serviço, quando aplicável.

Tipo: sinalizador

Valores válidos: quando presente, exibe cabeçalhos.

Padrão: a opção --headers fica desativada por padrão.

-I, --access-key-id VALUE

O ID da chave de acesso que será usada, em conjunto com a chave secreta, para assinar a solicitação. Esse parâmetro deverá ser usado em conjunto com --secret-key, ou a opção será ignorada. Todas as solicitações para o CloudWatch deverão ser assinadas, ou a solicitação será rejeitada.

Tipo: string

Valores válidos: um ID da chave de acesso válido.

Padrão: nenhum

-K, --ec2-private-key-file-path VALUE

A chave privada que será usada para assinar a solicitação. Utilizar chaves públicas/privadas faz com que a CLI use SOAP. A solicitação é assinada com um certificado público e uma chave privada. Esse parâmetro deverá ser usado em conjunto com EC2_CERT, ou o valor será ignorado. O valor da variável de ambiente EC2_PRIVATE_KEY será usado se estiver definido e se essa opção não estiver especificada. Essa opção será ignorada se a variável de ambiente AWS_CREDENTIAL_FILE estiver definida ou quando se utilizar --aws-credentials-file. Todas as solicitações para o CloudWatch deverão ser assinadas, ou a solicitação será rejeitada.

Tipo: string

Valores válidos: o caminho para uma chave privada ASN.1 válida.

Padrão: nenhum

--region VALUE

A região para onde as solicitações são direcionadas. É possível usar a variável de ambiente EC2_REGION para especificar o valor. Utiliza-se a região para criar a URL usada para chamar o CloudWatch e deve ser uma região da Amazon Web Services válida (AWS).

Tipo: string

Valores válidos: qualquer região da AWS, por exemplo, us-east-1.

Padrão: us-east-1, a menos que a variável de ambiente EC2_REGION esteja definida.

S, --secret-key VALUE

A chave de acesso secreta que será usada para assinar a solicitação, em conjunto com a ID da chave de acesso. Esse parâmetro deverá ser usado em conjunto com --access-key-id, ou essa opção será ignorada.

Tipo: string

Valores válidos: seu ID da chave de acesso.

Padrão: nenhum

--show-empty-fields

Exibe campos vazios usando (nil) como espaço reservado para indicar que esses dados não foram solicitados.

Tipo: sinalizador

Valores válidos: nenhum

Padrão: campos vazios não são exibidos por padrão.

--show-request

Exibe a URL que a CLI usa para chamar a AWS.

Tipo: sinalizador

Valores válidos: nenhum

Padrão: False

--show-table, --show-long, --show-xml, --quiet

Especifica como os resultados são exibidos: em uma tabela, delimitados (longos), XML ou nenhuma saída (silenciosos). A exibição --show-table mostra um subconjunto dos dados em forma fixa de largura de coluna; --show-long exibe todos os valores retornados delimitados por um caractere; --show-xml é o retorno bruto do serviço; e --quiet suprime todas as saídas padrão. Todas as opções são mutuamente exclusivas, tendo prioridade --show-table, --show-long, --show-xml e --quiet.

Tipo: sinalizador

Valores válidos: nenhum

Padrão: --show-table

-U, --url VALUE

A URL usada para entrar em contato com o CloudWatch. É possível definir esse valor usando a variável de ambiente AWS_CLOUDWATCH_URL. Esse valor é usado em conjunto com --region para criar a URL esperada. Essa opção substitui a URL da chamada de serviço.

Tipo: string

Valores válidos: uma URL HTTP ou HTTPS válida.

Padrão: usa o valor especificado em AWS_CLOUDWATCH_URL, se estiver definido.

Saída

Esse comando retorna uma tabela que contém o seguinte:

  • ALARM: nome do alarme.

  • DESCRIPTION: a descrição do alarme. Essa coluna só é mostrada na exibição --show-long.

  • STATE: o estado do alarme.

  • STATE_REASON: uma razão legível por humano do estado. Essa coluna só é mostrada na exibição --show-long.

  • STATE_REASON_DATA: uma razão legível por máquina para o estado (formato JSON). Essa coluna só é mostrada na exibição --show-long.

  • ENABLED: habilita ou desabilita ações. Essa coluna só é mostrada na exibição --show-long.

  • OK_ACTIONS: a ação a ser executada no status OK. Essa coluna só é mostrada na exibição --show-long.

  • ALARM_ACTIONS: a ação a ser executada no status ALARM.

  • INSUFFICIENT_DATA_ACTIONS: a ação a ser executada no status INSUFICIENT_DATA. Essa coluna só é mostrada na exibição --show-long.

  • NAMESPACE: um namespace da métrica.

  • METRIC_NAME: o nome da métrica.

  • DIMENSIONS: as dimensões da métrica. Essa coluna só é mostrada na exibição --show-long.

  • PERIOD: o período.

  • STATISTIC: a estatística (Average, Minimum, Maximum, Sum e SampleCount).

  • EXTENDEDSSTATISTIC: a estatística de percentil.

  • UNIT: a unidade. Essa coluna só é mostrada na exibição --show-long.

  • EVAL_PERIODS: o número de períodos para avaliar a métrica.

  • COMPARISON: o operador de comparação.

  • THRESHOLD: o limite.

A CLI do Amazon CloudWatch exibe erros em stderr.

Exemplos

Exemplo de solicitação

Esse exemplo descreve todos os alarmes cujo nome começa com my-alarm.

mon-describe-alarms --alarm-name-prefix my-alarm --headers

Essa é uma saída de exemplo desse 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

Tópicos relacionados da

Baixar

Ação relacionada

Comandos relacionados