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

Define várias regras de alerta de limite para uma métrica especificada de um recurso especificado.

Descrição da operação

Este tópico fornece um exemplo de como configurar uma regra de alerta de 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 para a regra 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 Critical é Average, o operador de comparação para o nível Critical é GreaterThanOrEqualToThreshold, o limite para o nível Critical é 90 e a contagem de novas tentativas de alerta para o nível Critical é 3.

Nota

Em 15 de agosto de 2024, a validação para Statistics foi adicionada. O valor estatístico deve corresponder ao Statistics da métrica correspondente. Para obter mais informações sobre como obter o valor desse parâmetro, consulte Métricas de serviço do 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:PutResourceMetricRules

create

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Rules	array<object>	Sim	A lista de regras de alerta de limite. Valores válidos de N: 1 a 50.
	array<object>	Não	Nenhum.
Escalations.Info.Threshold	string	Não	O limite de alerta para o nível Info. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	90
MetricName	string	Não	O nome da métrica. Valores válidos de N: 1 a 50. Para obter mais informações sobre como consultar o nome de uma métrica, consulte Métricas de serviço do Alibaba Cloud.	cpu_total
Escalations.Warn.Threshold	string	Não	O limite de alerta para o nível Warn. Valores válidos de N: 1 a 50. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	90
EffectiveInterval	string	Não	O período de vigência da regra de alerta. Valores válidos de N: 1 a 50.	00:00-23:59
NoEffectiveInterval	string	Não	O intervalo de tempo durante o qual a regra de alerta fica inativa. Valores válidos de N: 1 a 50.	00:00-06:00
RuleId	string	Sim	O ID da regra de alerta. Valores válidos de N: 1 a 50. Você pode inserir um novo ID de regra de alerta ou usar um ID de regra de alerta existente no CloudMonitor. Para obter mais informações sobre como consultar o ID de uma regra de alerta, consulte DescribeMetricRuleList. Nota Se você inserir um novo ID de regra de alerta, uma regra de alerta de limite será criada.	a151cd6023eacee2f0978e03863cc1697c89508****
Escalations.Critical.Times	integer	Não	O número de novas tentativas de alerta para o nível Critical. Valores válidos de N: 1 a 50. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	3
Escalations.Critical.Threshold	string	Não	O limite de alerta para o nível Critical. Valores válidos de N: 1 a 50. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	90
Escalations.Critical.Statistics	string	Não	O método estatístico para o nível Critical. Valores válidos de N: 1 a 50. O valor desse parâmetro é determinado pela coluna Statistics que corresponde ao MetricName do serviço do Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter mais informações sobre como obter o valor desse parâmetro, consulte Métricas de serviço do Alibaba Cloud. Nota Você deve configurar pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser configurados ao mesmo tempo para o nível de alerta especificado.	Average
Escalations.Warn.ComparisonOperator	string	Não	O operador de comparação para o nível Warn. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual a. GreaterThanThreshold: maior que. LessThanOrEqualToThreshold: menor ou igual a. LessThanThreshold: menor que. NotEqualToThreshold: diferente de. EqualToThreshold: igual a. GreaterThanYesterday: maior que o valor no mesmo horário de ontem. LessThanYesterday: menor que o valor no mesmo horário de ontem. GreaterThanLastWeek: maior que o valor no mesmo horário da semana passada. LessThanLastWeek: menor que o valor no mesmo horário da semana passada. GreaterThanLastPeriod: maior que o valor no último período. LessThanLastPeriod: menor que o valor no último período. Valores válidos de N: 1 a 50. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	GreaterThanOrEqualToThreshold
Escalations.Info.Times	integer	Não	O número de novas tentativas de alerta para o nível Info. Valores válidos de N: 1 a 50. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	3
Resources	string	Sim	As informações do recurso, como `[{"instanceId":"i-uf6j91r34rnwawoo**"}]` e `[{"userId":"100931896542**"}]`. Valores válidos de N: 1 a 50. Para obter mais informações sobre as dimensões suportadas pelas informações do recurso, consulte Métricas de serviço do Alibaba Cloud.	[{"instanceId":"i-uf6j91r34rnwawoo****"}]
SilenceTime	integer	Não	A época de silenciamento. Unidade: segundos. Valor padrão: 86400. Valores válidos de N: 1 a 50. Nota A época de silenciamento refere-se ao intervalo antes que o sistema possa enviar uma notificação de alerta novamente se o alerta não for limpo após ser acionado.	86400
Webhook	string	Não	A URL do webhook para a qual uma solicitação POST é enviada quando um alerta é acionado. Valores válidos de N: 1 a 50.	https://alert.aliyun.com.com:8080/callback
ContactGroups	string	Sim	O grupo de contatos de alerta. As notificações de alerta são enviadas para os contatos de alerta neste grupo de contatos de alerta. Valores válidos de N: 1 a 50. Nota Um grupo de contatos de alerta é um grupo de contatos de alerta e pode conter um ou mais contatos de alerta. Para obter mais informações sobre como criar um contato de alerta e um grupo de contatos de alerta, consulte PutContact e PutContactGroup.	ECS_Group
Namespace	string	Sim	O namespace de dados do serviço do Alibaba Cloud. Valores válidos de N: 1 a 50. Para obter mais informações sobre como consultar o namespace de dados de um serviço do Alibaba Cloud, consulte Métricas de serviço do Alibaba Cloud.	acs_ecs_dashboard
EmailSubject	string	Não	O assunto do e-mail de alerta. Valores válidos de N: 1 a 50.	ECS instance alert
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. Valores válidos de N: 1 a 50. Nota Para obter mais informações sobre como consultar o período estatístico de uma métrica, consulte Métricas de serviço do Alibaba Cloud.	60
RuleName	string	Sim	O nome da regra de alerta. Valores válidos de N: 1 a 50. Você pode inserir um novo nome de regra de alerta ou usar um nome de regra de alerta existente no CloudMonitor. Para obter mais informações sobre como consultar o nome de uma regra de alerta, consulte DescribeMetricRuleList. Nota Se você inserir um novo nome de regra de alerta, uma regra de alerta de limite será criada.	test123
Escalations.Info.Statistics	string	Não	O método estatístico para o nível Info. Valores válidos de N: 1 a 50. O valor desse parâmetro é determinado pela coluna Statistics que corresponde ao MetricName do serviço do Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter mais informações sobre como obter o valor desse parâmetro, consulte Métricas de serviço do Alibaba Cloud. Nota Você deve configurar pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser configurados ao mesmo tempo para o nível de alerta especificado.	Average
Escalations.Warn.Times	integer	Não	O número de novas tentativas de alerta para o nível Warn. Valores válidos de N: 1 a 50. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	3
Escalations.Info.ComparisonOperator	string	Não	O operador de comparação para o nível Info. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual a. GreaterThanThreshold: maior que. LessThanOrEqualToThreshold: menor ou igual a. LessThanThreshold: menor que. NotEqualToThreshold: diferente de. EqualToThreshold: igual a. GreaterThanYesterday: maior que o valor no mesmo horário de ontem. LessThanYesterday: menor que o valor no mesmo horário de ontem. GreaterThanLastWeek: maior que o valor no mesmo horário da semana passada. LessThanLastWeek: menor que o valor no mesmo horário da semana passada. GreaterThanLastPeriod: maior que o valor no último período. LessThanLastPeriod: menor que o valor no último período. Valores válidos de N: 1 a 50. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	GreaterThanOrEqualToThreshold
Interval	string	Não	O período de acionamento da regra de alerta. Unidade: segundos. Valores válidos de N: 1 a 50. Nota Para obter mais informações sobre como consultar o período estatístico de uma métrica, consulte Métricas de serviço do Alibaba Cloud.	60
Escalations.Critical.ComparisonOperator	string	Não	O operador de comparação para o nível Critical. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual a. GreaterThanThreshold: maior que. LessThanOrEqualToThreshold: menor ou igual a. LessThanThreshold: menor que. NotEqualToThreshold: diferente de. EqualToThreshold: igual a. GreaterThanYesterday: maior que o valor no mesmo horário de ontem. LessThanYesterday: menor que o valor no mesmo horário de ontem. GreaterThanLastWeek: maior que o valor no mesmo horário da semana passada. LessThanLastWeek: menor que o valor no mesmo horário da semana passada. GreaterThanLastPeriod: maior que o valor no último período. LessThanLastPeriod: menor que o valor no último período. Valores válidos de N: 1 a 50. Nota Você deve definir pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser definidos ao mesmo tempo para o nível de alerta especificado.	GreaterThanOrEqualToThreshold
Escalations.Warn.Statistics	string	Não	O método estatístico para o nível Warn. Valores válidos de N: 1 a 50. O valor desse parâmetro é determinado pela coluna Statistics que corresponde ao MetricName do serviço do Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter mais informações sobre como obter o valor desse parâmetro, consulte Métricas de serviço do Alibaba Cloud. Nota Você deve configurar pelo menos um dos seguintes níveis de alerta: Critical, Warn e Info. Os parâmetros Statistics, ComparisonOperator, Threshold e Times devem ser configurados ao mesmo tempo para o nível de alerta especificado.	Average
NoDataPolicy	string	Não	O método de tratamento quando não há dados de monitoramento disponíveis. Valores válidos: KEEP_LAST_STATE: Nenhuma ação é executada. Este é o valor padrão. INSUFFICIENT_DATA: O conteúdo do alerta indica que não há dados disponíveis. OK: Normal. Valores válidos de N: 1 a 50.	KEEP_LAST_STATE
Labels	array<object>	Não	Os rótulos que são gravados na métrica e exibidos na notificação de alerta quando a métrica atende à condição de alerta e um alerta é acionado.
	object	Não	Nenhum.
Key	string	Não	A chave do rótulo.	tagKey1
Value	string	Não	O valor do rótulo. Nota O valor do rótulo suporta parâmetros de modelo. Os parâmetros de modelo são substituídos pelos valores reais dos rótulos.	ECS
SendOK	boolean	Não	Especifica se deve enviar uma notificação de recuperação.	true
DryRun	boolean	Não	Especifica se deve apenas pré-verificar a solicitação. Valores válidos: true: Uma solicitação de verificação é enviada e nenhum grupo de segurança é associado à instância. Os itens de verificação incluem se os parâmetros obrigatórios são especificados, o formato da solicitação e os limites de serviço. Se a verificação falhar, um erro será retornado. Se a verificação for bem-sucedida, o código de erro DryRunOperation será retornado. false: Uma solicitação normal é enviada. Se a verificação for bem-sucedida, um código de status HTTP 2xx será retornado e a operação será executada. Este é o valor padrã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. Nota Um valor de 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.	15D1440E-BF24-5A41-93E4-36864635179E
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
FailedListResult	object
Target	array<object>	A lista de resultados de falha para a definição de regras de alerta para recursos.
	array<object>	Nenhum.
RuleId	string	O ID da regra de alerta.	a151cd6023eacee2f0978e03863cc1697c89508****
Result	object	O resultado da falha.
Code	string	O código de status.	404
Message	string	A mensagem de erro.	The request processing has failed due to some unknown error.
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.	false

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "15D1440E-BF24-5A41-93E4-36864635179E",
  "Success": true,
  "FailedListResult": {
    "Target": [
      {
        "RuleId": "a151cd6023eacee2f0978e03863cc1697c89508****",
        "Result": {
          "Code": "404",
          "Message": "The request processing has failed due to some unknown error.",
          "Success": false
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	%s	%s
422	%s	%s
499	%s	%s
412	DryRunOperation	%s.	O resultado da pré-verificação de dry run.
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

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.