DescribeAlertingMetricRuleResources - Cloud Monitor: Central de Documentação do Alibaba Cloud

Consulta a lista de recursos que estão acionando alertas para uma regra de alerta especificada.

Descrição da operação

Este tópico fornece um exemplo para mostrar como definir uma regra de alerta baseada em limite para a métrica cpu_total da instância do Elastic Compute Service (ECS) i-uf6j91r34rnwawoo**** no namespace acs_ecs_dashboard. O grupo de contatos de alerta é ECS_Group, o nome da regra de alerta é test123, o ID da regra de alerta é a151cd6023eacee2f0978e03863cc1697c89508****, o método estatístico para o nível Crítico é Average, o operador de comparação para o nível Crítico é GreaterThanOrEqualToThreshold, o limite para o nível Crítico é 90 e a contagem de tentativas para o nível Crítico é 3.

Nota

Em 15 de agosto de 2024, a validação de estatísticas foi adicionada. O valor estatístico deve corresponder às estatísticas da métrica. Para mais informações sobre como obter o valor deste parâmetro, consulte Métricas de monitoramento de serviços da Alibaba Cloud.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cms:DescribeAlertingMetricRuleResources

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RuleId	string	Não	O ID da regra de alerta. Para mais informações sobre como consultar IDs de regras de alerta, consulte DescribeMetricRuleList.	putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****
GroupId	string	Não	O ID do grupo de aplicativos. Para mais informações sobre como consultar IDs de grupos de aplicativos, consulte DescribeMonitorGroups.	7671****
Page	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10
Namespace	string	Não	O namespace de dados do serviço da Alibaba Cloud. Para mais informações sobre como obter o namespace de dados de um serviço da Alibaba Cloud, consulte Métricas de monitoramento de serviços da Alibaba Cloud.	acs_mns_new.
Dimensions	string	Não	O mapa de dimensões usado para consultar dados de monitoramento de um recurso especificado.	{\"userId\":\"120886317861****\",\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\"}
AlertBeforeTime	string	Não	Consulta alertas ocorridos antes deste ponto no tempo. O valor é um timestamp em milissegundos.	1698827400000

Para mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Nenhum.
Code	integer	O código de status. Nota Um valor 200 indica sucesso.	200
Message	string	A mensagem de erro.	The request processing has failed due to some unknown error.
RequestId	string	O ID da solicitação.	0724011B-D9E0-4B2F-8C51-F17A894CC42C
Total	integer	O número total de registros.	2
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: A operação foi bem-sucedida. false: A operação falhou.	true.
Resources	object
Resource	array<object>	A lista de recursos associados à regra de alerta.
	array<object>	Nenhum.
MetricName	string	O nome da métrica.	ActiveMessages
RetryTimes	string	O número de tentativas de alerta.	3
MetricValues	string	Os valores das métricas quando o alerta foi acionado. O valor é uma string JSON.	{\"timestamp\":1623727500000,\"Sum\":926,\"value\":463,\"Maximum\":463,\"Minimum\":463,\"Average\":463,\"SampleCount\":2,\"userId\":\"120886317861****\",\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\"}
Namespace	string	O namespace do serviço em nuvem.	acs_mns_new
RuleName	string	O nome da regra de alerta.	test123456789
RuleId	string	O ID da regra de alerta.	putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****
ProductCategory	string	O tipo de serviço em nuvem.	mns
StartTime	string	O timestamp quando o recurso foi associado à regra de alerta. Unidade: milissegundos.	1622427900000
Resource	string	O recurso que acionou o alerta.	userId=120886317861****,region=cn-huhehaote,queue=test-0128
LastModifyTime	string	O timestamp quando a regra de alerta foi modificada pela última vez. Unidade: milissegundos.	1622827900000
GroupId	string	O ID do grupo de aplicativos. Nota Se a regra de alerta estiver associada a um grupo de aplicativos especificado, este ID do grupo de aplicativos será exibido.	7671****
Dimensions	string	O mapa de dimensões usado para consultar dados de monitoramento de um recurso especificado.	{\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\",\"userId\":\"120886317861****\"}
LastAlertTime	string	O timestamp quando o alerta foi acionado pela última vez. Unidade: milissegundos.	1622427900000
Level	integer	O nível de alerta e o método de notificação. Valores válidos: 4: e-mail + chatbot do DingTalk. OK: nenhum alerta.	3
Threshold	string	O limite de alerta.	10
Statistics	string	O método estatístico para o alerta.	Average
Enable	string	Indica se a regra de alerta está ativada. Valores válidos: true: A regra de alerta está ativada. false: A regra de alerta está desativada.	true
Escalation	object
Resource	array<object>	A regra que acionou o alerta.
	array<object>	Nenhum.
ComparisonOperator	string	O operador de comparação de limite. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual a GreaterThanThreshold: maior que LessThanOrEqualToThreshold: menor ou igual a LessThanThreshold: menor que NotEqualToThreshold: diferente de GreaterThanYesterday: aumentou em comparação com o mesmo horário ontem LessThanYesterday: diminuiu em comparação com o mesmo horário ontem GreaterThanLastWeek: aumentou em comparação com o mesmo horário na semana passada LessThanLastWeek: diminuiu em comparação com o mesmo horário na semana passada GreaterThanLastPeriod: aumentou em comparação com o período anterior LessThanLastPeriod: diminuiu em comparação com o período anterior	GreaterThanOrEqualToThreshold
PreCondition	string	O símbolo de comparação de limite. Valores válidos: `>=` `=` `<=` `>` `<` `!=`	>=
Expression	string	A descrição da regra que acionou o alerta. Nota Este é o corpo da regra de alerta. Quando os dados de monitoramento atendem à condição de alerta, a regra de alerta é acionada.	$Average>=10
Times	integer	O número de tentativas de alerta.	1
Tag	string	Este parâmetro foi descontinuado e pode ser ignorado.	Deprecated: true
Threshold	string	O limite de alerta.	10
Level	integer	O nível de alerta e o método de notificação. Valores válidos: 4: e-mail + chatbot do DingTalk. OK: nenhum alerta.	3
ExpressionListJoin	string	A relação entre múltiplas métricas. Valores válidos: &&: Uma notificação de alerta é enviada apenas quando todas as métricas atendem às condições de alerta. \|\|: Uma notificação de alerta é enviada quando qualquer métrica atende às condições de alerta.	&&
ExpressionList	object
ExpressionList	array<object>	A descrição da regra de alerta de múltiplas métricas.
	object	Nenhum.
ComparisonOperator	string	O operador de comparação de limite para o nível de alerta. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual a GreaterThanThreshold: maior que LessThanOrEqualToThreshold: menor ou igual a LessThanThreshold: menor que NotEqualToThreshold: diferente de GreaterThanYesterday: aumentou em comparação com o mesmo horário ontem LessThanYesterday: diminuiu em comparação com o mesmo horário ontem GreaterThanLastWeek: aumentou em comparação com o mesmo horário na semana passada LessThanLastWeek: diminuiu em comparação com o mesmo horário na semana passada GreaterThanLastPeriod: aumentou em comparação com o período anterior LessThanLastPeriod: diminuiu em comparação com o período anterior	GreaterThanOrEqualToThreshold
MetricName	string	O nome da métrica.	cpu_total
Period	string	O período estatístico da métrica. Unidade: segundos. O valor padrão é o período de relatório original da métrica.	60
Statistics	string	O método estatístico para o nível de alerta. Valores válidos: Maximum: valor máximo Minimum: valor mínimo Average: valor médio	Average
Threshold	string	O limite de alerta.	90
ExpressionRaw	string	A condição de alerta criada usando uma expressão. Os seguintes cenários são suportados, mas não limitados a: Definir uma lista negra de alertas para recursos específicos. Por exemplo, $instanceId != 'i-io8kfvcpp7x5**' ``&&`` $Average > 50 especifica que nenhum alerta é acionado para a instância `i-io8kfvcpp7x5` mesmo que seu `Average` exceda 50. Definir um limite de alerta especial para uma instância específica na regra. Por exemplo, `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)` especifica que um alerta é acionado para a instância `i-io8kfvcpp7x5**` apenas quando seu `Average` excede 80, enquanto um alerta é acionado para outras instâncias quando seu `Average` excede 50. Limitar o número de instâncias que excedem o limite. Por exemplo, `count($Average > 20) > 3` especifica que um alerta é acionado apenas quando mais de três instâncias na regra de alerta têm um `Average` maior que 20.	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "0724011B-D9E0-4B2F-8C51-F17A894CC42C",
  "Total": 2,
  "Success": true,
  "Resources": {
    "Resource": [
      {
        "MetricName": "ActiveMessages",
        "RetryTimes": "3",
        "MetricValues": "{\\\"timestamp\\\":1623727500000,\\\"Sum\\\":926,\\\"value\\\":463,\\\"Maximum\\\":463,\\\"Minimum\\\":463,\\\"Average\\\":463,\\\"SampleCount\\\":2,\\\"userId\\\":\\\"120886317861****\\\",\\\"region\\\":\\\"cn-huhehaote\\\",\\\"queue\\\":\\\"test-0128\\\"}",
        "Namespace": "acs_mns_new",
        "RuleName": "test123456789",
        "RuleId": "putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****",
        "ProductCategory": "mns",
        "StartTime": "1622427900000",
        "Resource": "userId=120886317861****,region=cn-huhehaote,queue=test-0128",
        "LastModifyTime": "1622827900000",
        "GroupId": "7671****",
        "Dimensions": "{\\\"region\\\":\\\"cn-huhehaote\\\",\\\"queue\\\":\\\"test-0128\\\",\\\"userId\\\":\\\"120886317861****\\\"}",
        "LastAlertTime": "1622427900000",
        "Level": 3,
        "Threshold": "10",
        "Statistics": "Average",
        "Enable": "true",
        "Escalation": {
          "Resource": [
            {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "PreCondition": ">=",
              "Expression": "$Average>=10",
              "Times": 1,
              "Tag": "Deprecated: true",
              "Threshold": "10",
              "Level": 3,
              "ExpressionListJoin": "&&",
              "ExpressionList": {
                "ExpressionList": [
                  {
                    "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                    "MetricName": "cpu_total",
                    "Period": "60",
                    "Statistics": "Average",
                    "Threshold": "90"
                  }
                ]
              },
              "ExpressionRaw": "$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
404	%s	%s
503	%s	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.