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.

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

*全部资源

*

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 obter 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 obter 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 em nuvem. Para obter informações sobre como obter o namespace de dados de um serviço em nuvem, consulte Métricas de monitoramento de serviços em nuvem.	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 obter 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 consecutivo de vezes em que o valor da métrica atende à condição de alerta antes que um alerta seja acionado.	3
MetricValues	string	O valor da métrica que acionou o alerta com base na regra de alerta. 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 de 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 do serviço de nuvem.	mns
StartTime	string	O horário em que o recurso foi associado à regra de alerta. O valor é um timestamp. Unidade: milissegundos.	1622427900000
Resource	string	Os recursos que são monitorados.	userId=120886317861****,region=cn-huhehaote,queue=test-0128
LastModifyTime	string	O horário em que a regra de alerta foi modificada pela última vez. O valor é um timestamp. Unidade: milissegundos.	1622827900000
GroupId	string	O ID do grupo de aplicativos. Nota Se a regra de alerta estiver associada a um grupo de aplicativos, o ID do grupo de aplicativos será retornado neste parâmetro.	7671****
Dimensions	string	As dimensões com base nas quais os recursos são consultados.	{\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\",\"userId\":\"120886317861****\"}
LastAlertTime	string	O horário em que o último alerta foi acionado para o recurso com base na regra de alerta. O valor é um timestamp. Unidade: milissegundos.	1622427900000
Level	integer	O nível de gravidade e os métodos de notificação do alerta. Valores válidos: 4: As notificações de alerta são enviadas por e-mails e chatbots do DingTalk. OK: Nenhum alerta é gerado.	3
Threshold	string	O limite do alerta.	10
Statistics	string	O método usado para calcular os valores de métrica que acionam alertas.	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 de alerta com base na qual o alerta é acionado.
	array<object>	Nenhum.
ComparisonOperator	string	O operador usado para comparar o valor da métrica com o limite. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual ao limite GreaterThanThreshold: maior que o limite LessThanOrEqualToThreshold: menor ou igual ao limite LessThanThreshold: menor que o limite NotEqualToThreshold: diferente do limite GreaterThanYesterday: maior que o valor da métrica no mesmo horário ontem LessThanYesterday: menor que o valor da métrica no mesmo horário ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário na semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário na semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no último ciclo de monitoramento	GreaterThanOrEqualToThreshold
PreCondition	string	O operador usado para comparar o valor da métrica com o limite. Valores válidos: `>=` `=` `<=` `>` `<` `!=`	>=
Expression	string	A descrição da regra de alerta. Nota Este parâmetro indica o conteúdo da regra de alerta. Se o valor da métrica atender à condição de alerta, um alerta será acionado.	$Average>=10
Times	integer	O número consecutivo de vezes em que o valor da métrica atende à condição de alerta antes que um alerta seja acionado.	1
Tag	string	Este parâmetro foi descontinuado.	无
Threshold	string	O limite do alerta.	10
Level	integer	O nível de gravidade e os métodos de notificação do alerta. Valores válidos: 4: As notificações de alerta são enviadas por e-mails e chatbots do DingTalk. OK: Nenhum alerta é gerado.	3
ExpressionListJoin	string	A relação entre várias métricas. Valores válidos: &&: Se todas as métricas atenderem às condições de alerta, o CloudMonitor enviará notificações de alerta. \|\|: Se uma das métricas atender às condições de alerta, o CloudMonitor enviará notificaçõ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 usado para comparar o valor da métrica com o limite. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual ao limite GreaterThanThreshold: maior que o limite LessThanOrEqualToThreshold: menor ou igual ao limite LessThanThreshold: menor que o limite NotEqualToThreshold: diferente do limite GreaterThanYesterday: maior que o valor da métrica no mesmo horário ontem LessThanYesterday: menor que o valor da métrica no mesmo horário ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário na semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário na semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no último ciclo de monitoramento	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 intervalo no qual os dados de monitoramento da métrica são coletados.	60
Statistics	string	O método estatístico do nível de alerta. Valores válidos: Maximum Minimum Average	Average
Threshold	string	O limite do alerta.	90
ExpressionRaw	string	As condições de acionamento criadas usando expressões. Você pode usar expressões para criar condições de acionamento nos seguintes cenários: Definir uma lista negra de alertas para recursos específicos. Por exemplo, se você especificar $instanceId != 'i-io8kfvcpp7x5**' ``&&`` $Average > 50, nenhum alerta será acionado quando o `valor médio da métrica` da instância `i-io8kfvcpp7x5` exceder 50. Definir um limite de alerta especial para uma instância especificada na regra. Por exemplo, se você especificar `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)`, um alerta será acionado quando o `valor médio da métrica` da instância `i-io8kfvcpp7x5**` exceder 80 ou o `valor médio da métrica` de outras instâncias exceder 50. Limitar o número de instâncias cujos valores de métrica excedem o limite. Por exemplo, se você especificar `count($Average > 20) > 3`, um alerta será acionado somente quando o `valor médio da métrica` de mais de três instâncias exceder 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": "无",
              "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.