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

Define uma regra de alerta.

Descrição da operação

Este tópico fornece um exemplo de como definir uma regra de alerta de limite para a métrica cpu_total da instância do Elastic Computing 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

A partir de 15 de agosto de 2024, a validação de Statistics foi aumentada. O valor estatístico deve corresponder ao Statistics da métrica correspondente. Para obter 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:PutResourceMetricRule

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RuleId	string	Sim	O ID da regra de alerta. Você pode inserir um novo ID de regra de alerta ou usar o ID de uma regra de alerta existente no CloudMonitor. Para obter mais informações sobre como consultar IDs de regras de alerta, consulte DescribeMetricRuleList. Nota Se você inserir um novo ID de regra de alerta, uma regra de alerta de limite será criada.	a151cd6023eacee2f0978e03863cc1697c89508****
RuleName	string	Sim	O nome da regra de alerta. Você pode inserir um novo nome de regra de alerta ou usar o nome de uma regra de alerta existente no CloudMonitor. Para obter mais informações sobre como consultar nomes de regras de alerta, consulte DescribeMetricRuleList. Nota Se você inserir um novo nome de regra de alerta, uma regra de alerta de limite será criada.	test123
Namespace	string	Sim	O namespace do serviço da Alibaba Cloud. Para obter mais informações sobre como consultar o namespace de um serviço da Alibaba Cloud, consulte Métricas de monitoramento de serviços da Alibaba Cloud. Nota Se você criar uma regra de alerta do Prometheus para o Hybrid Cloud Monitoring, defina este parâmetro como `acs_prometheus`.	acs_ecs_dashboard
MetricName	string	Sim	O nome da métrica. Para obter mais informações sobre como consultar nomes de métricas, consulte Métricas de monitoramento de serviços da Alibaba Cloud. Nota Se você criar uma regra de alerta do Prometheus para o Hybrid Cloud Monitoring, este parâmetro especifica o nome do repositório de métricas. Para obter mais informações sobre como obter o nome do repositório de métricas, consulte DescribeHybridMonitorNamespaceList.	cpu_total
Resources	string	Não	As informações do recurso, como `[{"instanceId":"i-uf6j91r34rnwawoo**"}]` ou `[{"userId":"100931896542**"}]`. Para obter mais informações sobre as dimensões de monitoramento suportadas, consulte Métricas de monitoramento de serviços da Alibaba Cloud.	[{"instanceId":"i-uf6j91r34rnwawoo****"}]
ContactGroups	string	Sim	O grupo de contatos de alerta. As notificações de alerta são enviadas para os contatos de alerta no grupo de contatos de alerta. Nota Um grupo de contatos de alerta é um grupo de contatos de alerta que pode conter um ou mais contatos de alerta. Para obter mais informações sobre como criar contatos de alerta e grupos de contatos de alerta, consulte PutContact e PutContactGroup.	ECS_Group
Webhook	string	Não	A URL de callback para a qual uma solicitação POST é enviada quando um alerta é acionado.	https://alert.aliyun.com.com:8080/callback
EffectiveInterval	string	Não	O período de vigência da regra de alerta.	00:00-23:59
NoEffectiveInterval	string	Não	O intervalo de tempo durante o qual a regra de alerta fica inativa.	00:00-06:00
SilenceTime	integer	Não	O período de silenciamento. Unidade: segundos. Valor padrão: 86400. Nota O período de silenciamento especifica o intervalo no qual uma notificação de alerta é reenviada se o alerta não for recuperado para Normal.	86400
Period	string	Não	O período estatístico da métrica. Unidade: segundos. O valor padrão é o período de relatório original da métrica. Nota Para obter mais informações sobre como consultar o período estatístico de uma métrica, consulte Métricas de monitoramento de serviços da Alibaba Cloud.	60
Interval	string	Não	O período de acionamento da regra de alerta. Unidade: segundos. Nota Para obter mais informações sobre como consultar o período estatístico de uma métrica, consulte Métricas de monitoramento de serviços da Alibaba Cloud.	60
EmailSubject	string	Não	O assunto do e-mail de alerta.	ECS instance alert
Escalations.Critical.Statistics	string	Não	O método estatístico para o nível Crítico. O valor deste parâmetro é determinado pela coluna `Statistics` correspondente ao `MetricName` do serviço da Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter mais informações sobre como obter o valor deste parâmetro, consulte Métricas de monitoramento de serviços da Alibaba Cloud. Nota Pelo menos um dos níveis de alerta Critical (crítico), Warn (aviso) ou Info (informação) deve ser configurado. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	Average
Escalations.Critical.ComparisonOperator	string	Não	O operador de comparação para o nível Crítico. 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. EqualToThreshold: igual ao limite. GreaterThanYesterday: maior que o valor no mesmo horário ontem. LessThanYesterday: menor que o valor no mesmo horário ontem. GreaterThanLastWeek: maior que o valor no mesmo horário na semana passada. LessThanLastWeek: menor que o valor no mesmo horário na semana passada. GreaterThanLastPeriod: maior que o valor no último período. LessThanLastPeriod: menor que o valor no último período. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	GreaterThanOrEqualToThreshold
Escalations.Critical.Threshold	string	Não	O limite para o nível Crítico. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	90
Escalations.Critical.Times	integer	Não	A contagem de tentativas para o nível Crítico. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	3
Escalations.Warn.Statistics	string	Não	O método estatístico para o nível de Aviso. O valor deste parâmetro é determinado pela coluna `Statistics` correspondente ao `MetricName` do serviço da Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter mais informações sobre como obter o valor deste parâmetro, consulte Métricas de monitoramento de serviços da Alibaba Cloud. Nota Pelo menos um dos níveis de alerta Critical (crítico), Warn (aviso) ou Info (informação) deve ser configurado. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	Average
Escalations.Warn.ComparisonOperator	string	Não	O operador de comparação para o nível de Aviso. 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. EqualToThreshold: igual ao limite. GreaterThanYesterday: maior que o valor no mesmo horário ontem. LessThanYesterday: menor que o valor no mesmo horário ontem. GreaterThanLastWeek: maior que o valor no mesmo horário na semana passada. LessThanLastWeek: menor que o valor no mesmo horário na semana passada. GreaterThanLastPeriod: maior que o valor no último período. LessThanLastPeriod: menor que o valor no último período. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	GreaterThanOrEqualToThreshold
Escalations.Warn.Threshold	string	Não	O limite para o nível de Aviso. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	90
Escalations.Warn.Times	integer	Não	A contagem de tentativas para o nível de Aviso. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	3
Escalations.Info.Statistics	string	Não	O método estatístico para o nível de Informação. O valor deste parâmetro é determinado pela coluna `Statistics` correspondente ao `MetricName` do serviço da Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter mais informações sobre como obter o valor deste parâmetro, consulte Métricas de monitoramento de serviços da Alibaba Cloud. Nota Pelo menos um dos níveis de alerta Critical (crítico), Warn (aviso) ou Info (informação) deve ser configurado. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	Average
Escalations.Info.ComparisonOperator	string	Não	O operador de comparação para o nível de Informação. 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. EqualToThreshold: igual ao limite. GreaterThanYesterday: maior que o valor no mesmo horário ontem. LessThanYesterday: menor que o valor no mesmo horário ontem. GreaterThanLastWeek: maior que o valor no mesmo horário na semana passada. LessThanLastWeek: menor que o valor no mesmo horário na semana passada. GreaterThanLastPeriod: maior que o valor no último período. LessThanLastPeriod: menor que o valor no último período. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	GreaterThanOrEqualToThreshold
Escalations.Info.Threshold	string	Não	O limite para o nível de Informação. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	90
Escalations.Info.Times	integer	Não	A contagem de tentativas para o nível de Informação. Nota Pelo menos um dos níveis de alerta Critical, Warn ou Info deve ser definido. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos juntos para o nível de alerta especificado.	3
NoDataPolicy	string	Não	O método de processamento quando nenhum dado de monitoramento é encontrado. Valores válidos: KEEP_LAST_STATE (padrão): Nenhuma ação é executada. INSUFFICIENT_DATA: Um alerta cujo conteúdo é "Insufficient Data" é acionado. OK: O status é considerado normal.	KEEP_LAST_STATE
CompositeExpression	object	Não	As condições de alerta para múltiplas métricas. Nota As condições de alerta de métrica única e de múltiplas métricas são mutuamente exclusivas e não podem ser definidas ao mesmo tempo.
ExpressionList	array<object>	Não	A lista de condições de alerta criadas no modo padrão.
	object	Não	Nenhum.
MetricName	string	Não	O nome da métrica do serviço da Alibaba Cloud.	cpu_total
Period	integer	Não	O período de agregação da métrica. Unidade: segundos.	60
Statistics	string	Não	O método estatístico da métrica. Valores válidos: $Maximum: valor máximo. $Minimum: valor mínimo. $Average: valor médio. $Availability: taxa de disponibilidade (normalmente usada para monitoramento de site). Nota `$` é o prefixo unificado para métricas. Para obter mais informações sobre os serviços da Alibaba Cloud suportados, consulte Métricas de monitoramento de serviços da Alibaba Cloud.	$Maximum
ComparisonOperator	string	Não	O operador de comparação para 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. EqualToThreshold: igual ao limite. GreaterThanYesterday: maior que o valor no mesmo horário ontem. LessThanYesterday: menor que o valor no mesmo horário ontem. GreaterThanLastWeek: maior que o valor no mesmo horário na semana passada. LessThanLastWeek: menor que o valor no mesmo horário na semana passada. GreaterThanLastPeriod: maior que o valor no último período. LessThanLastPeriod: menor que o valor no último período.	GreaterThanOrEqualToThreshold
Threshold	string	Não	O limite do alerta.	90
ExpressionListJoin	string	Não	A relação entre as condições de alerta de múltiplas métricas. Valores válidos: `&&`: Um alerta é acionado somente quando todas as métricas atendem às condições de alerta. Um alerta é acionado somente quando todas as expressões em ExpressionList são avaliadas como `true`. `\|\|`: Um alerta é acionado quando qualquer métrica atende às condições de alerta.	\|\|
ExpressionRaw	string	Não	A condição de alerta criada usando uma expressão. Isso inclui, mas não se limita a, os seguintes cenários: Definir uma lista de bloqueio 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**` somente quando seu `Average` exceder 80, enquanto um alerta é acionado para outras instâncias quando seu `Average` exceder 50. Limitar o número de instâncias que excedem o limite. Por exemplo, `count($Average > 20) > 3` especifica que um alerta é acionado somente quando mais de três instâncias na regra de alerta tiverem um `Average` maior que 20.	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)
Level	string	Não	O nível de alerta. Valores válidos: CRITICAL: crítico. WARN: aviso. INFO: informação.	CRITICAL
Times	integer	Não	O número de vezes que a condição de alerta deve ser atendida antes que uma notificação de alerta seja enviada.	3
Labels	array<object>	Não	Quando a métrica atende à condição de alerta e um alerta é acionado, os labels são gravados na métrica e exibidos na notificação de alerta. Nota Este recurso é igual ao recurso Label nos alertas do Prometheus.
	object	Não	Nenhum.
Key	string	Não	A chave do label.	tagKey1
Value	string	Não	O valor do label. Nota O valor do label suporta parâmetros de modelo. Os parâmetros de modelo são substituídos pelos valores reais dos labels.	ECS
Prometheus	object	Não	A configuração de alerta do Prometheus. Nota Defina este parâmetro somente quando você criar uma regra de alerta do Prometheus para o Hybrid Cloud Monitoring.
PromQL	string	Não	A instrução de consulta PromQL. Nota Os dados recuperados pela instrução de consulta PromQL são os dados de alerta. Inclua o limite de alerta nesta instrução.	cpuUsage{instanceId="xxxx"}[1m]>90
Level	string	Não	O nível de alerta. Valores válidos: CRITICAL: crítico. WARN: aviso. INFO: informação.	CRITICAL
Times	integer	Não	O número de vezes que a condição de alerta deve ser atendida antes que uma notificação de alerta seja enviada.	3
Annotations	array<object>	Não	As anotações para alertas do Prometheus. As chaves e valores de anotação são renderizados para ajudar você a entender as métricas ou regras de alerta. Nota Este recurso é equivalente ao recurso Annotation no Prometheus.
	object	Não	Nenhum.
Key	string	Não	A chave da anotação.	summary
Value	string	Não	O valor da anotação.	{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }
SendOK	boolean	Não	Especifica se deve ser enviada uma notificação de recuperação.	true

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	string	O código de status HTTP. Nota O 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.	65D50468-ECEF-48F1-A6E1-D952E89D9436
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

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "65D50468-ECEF-48F1-A6E1-D952E89D9436",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	%s	%s
499	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s
429	ResourceOverLimit	The resource has exceeded the limit. %s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.