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

Cria regras de alerta em lotes para um grupo de aplicativos especificado chamando a operação CreateGroupMetricRules.

Descrição da operação

Este tópico fornece um exemplo de como criar uma regra de alerta para a métrica de monitoramento cpu_total do Elastic Computing Service (ECS) no grupo de aplicativos 123456. O ID da regra de alerta é 456789, o nome da regra de alerta é ECS_Rule1, a severidade do alerta é Critical, o método estatístico é Average, o operador de comparação é GreaterThanOrEqualToThreshold, o limite é 90 e a contagem de tentativas é 3. A resposta mostra que a regra de alerta ECS_Rule1 foi criada.

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:CreateGroupMetricRules

create

*GroupMetricRule

acs:cms::{#accountId}:group/{#groupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	integer	Sim	O ID do grupo de aplicativos. Para obter informações sobre como obter o ID do grupo de aplicativos, consulte DescribeMonitorGroups.	3607****
GroupMetricRules	array<object>	Não	A lista de regras de alerta baseadas em métricas para o grupo de aplicativos.
	array<object>	Não	A regra de alerta baseada em métricas para o grupo de aplicativos.
Escalations.Info.Threshold	string	Não	O limite para alertas de nível Info. Valores válidos de N: 1 a 200. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	10
MetricName	string	Sim	O nome da métrica. Valores válidos de N: 1 a 200. Para obter informações sobre como obter o nome da métrica, consulte DescribeMetricMetaList ou Monitoramento de serviços em nuvem.	cpu_total
Escalations.Warn.Threshold	string	Não	O limite para alertas de nível Warn. Valores válidos de N: 1 a 200. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	20
EffectiveInterval	string	Não	O período de vigência da regra de alerta. Valores válidos de N: 1 a 200.	05:31-23:59
NoEffectiveInterval	string	Não	O período de tempo durante o qual a regra de alerta fica inativa. Valores válidos de N: 1 a 200.	00:00-05:30
RuleId	string	Sim	O ID da regra de alerta. Valores válidos de N: 1 a 200.	456789
Escalations.Critical.Times	integer	Não	O número de vezes que a métrica de monitoramento deve atingir o limite de alerta antes que uma notificação de alerta de nível Critical seja enviada. Valores válidos de N: 1 a 200. Nota As configurações para pelo menos um dos níveis de severidade de alerta Critical, Warn (aviso) ou Info devem ser especificadas. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	3
Dimensions	string	Não	As dimensões de monitoramento do recurso especificado. O valor é uma coleção de pares `chave:valor`, como `{"userId":"120886317861**"}` e `{"instanceId":"i-2ze2d6j5uhg20x47**"}`.	[{"instanceId":"i-m5e1qg6uo38rztr4****"}]
Escalations.Critical.Threshold	string	Não	O limite que aciona as notificações de alerta de nível Critical. Valores válidos de N: 1 a 200. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	90
Escalations.Critical.Statistics	string	Não	O método estatístico para alertas de nível Critical. Valores válidos de N: 1 a 200. Os valores válidos deste parâmetro são determinados pela coluna `Statistics` correspondente ao `MetricName` do serviço da Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter informações sobre como obter os valores válidos, consulte Monitoramento de serviços em nuvem. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	Average
Escalations.Warn.ComparisonOperator	string	Não	O operador de comparação para alertas de nível Warn. 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 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 200. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	GreaterThanOrEqualToThreshold
Escalations.Info.Times	integer	Não	O número de vezes que a métrica de monitoramento deve atingir o limite de alerta antes que uma notificação de alerta de nível Info seja enviada. Valores válidos de N: 1 a 200. Nota As configurações para pelo menos um dos níveis de severidade de alerta Critical, Warn (aviso) ou Info devem ser especificadas. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	1
SilenceTime	integer	Não	O período de silêncio da notificação de alerta. Valores válidos de N: 1 a 200. Unidade: segundos. Valor padrão: 86400. Valor mínimo: 3600.	86400
Webhook	string	Não	A URL de callback para a qual uma notificação de alerta é enviada. Valores válidos de N: 1 a 200. Especifique uma URL publicamente acessível. O CloudMonitor envia uma solicitação POST para enviar as informações de alerta para esta URL. Apenas o protocolo HTTP é suportado.	https://www.aliyun.com
Namespace	string	Sim	O namespace do serviço da Alibaba Cloud. Valores válidos de N: 1 a 200. Para obter informações sobre como obter o namespace de um serviço da Alibaba Cloud, consulte DescribeMetricMetaList ou Monitoramento de serviços em nuvem.	acs_ecs_dashboard
EmailSubject	string	Não	O assunto do e-mail de notificação de alerta. Valores válidos de N: 1 a 200.	ECS instance
Period	string	Não	O período de relatório dos dados de monitoramento. Valores válidos de N: 1 a 200. O valor de `Period` deve ser 60 ou um múltiplo de 60. Unidade: segundos. Valor padrão: 300.	60
RuleName	string	Sim	O nome da regra de alerta. Valores válidos de N: 1 a 200.	ECS_Rule1
Escalations.Info.Statistics	string	Não	O método estatístico para alertas de nível Info. Valores válidos de N: 1 a 200. Os valores válidos deste parâmetro são determinados pela coluna `Statistics` correspondente ao `MetricName` do serviço da Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter informações sobre como obter os valores válidos, consulte Monitoramento de serviços em nuvem. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	Average
Escalations.Warn.Times	integer	Não	O número de vezes que a métrica de monitoramento deve atingir o limite de alerta antes que uma notificação de alerta de nível Warn seja enviada. Valores válidos de N: 1 a 200. Nota As configurações para pelo menos um dos níveis de severidade de alerta Critical, Warn (aviso) ou Info devem ser especificadas. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	3
Escalations.Info.ComparisonOperator	string	Não	O operador de comparação para alertas de nível Info. 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 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 200. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	GreaterThanOrEqualToThreshold
Interval	string	Não	O período de detecção da regra de alerta. Valores válidos de N: 1 a 200. Unidade: segundos. O valor padrão é a frequência mínima de relatório da métrica. Nota Mantenha o período de detecção da regra de alerta consistente com o período de relatório de dados. Se o período de detecção for menor que o período de relatório de dados, os alertas podem não ser acionados devido a dados insuficientes.	60
Category	string	Sim	A abreviação do nome do serviço da Alibaba Cloud. Valores válidos de N: 1 a 200. Para obter informações sobre como obter a abreviação, consulte a tag `metricCategory` no parâmetro de resposta `Labels` da operação DescribeProjectMeta.	ECS
Escalations.Critical.ComparisonOperator	string	Não	O operador de comparação para alertas de nível Critical. 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 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 200. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	GreaterThanOrEqualToThreshold
Escalations.Warn.Statistics	string	Não	O método estatístico para alertas de nível Warn. Valores válidos de N: 1 a 200. Os valores válidos deste parâmetro são determinados pela coluna `Statistics` correspondente ao `MetricName` do serviço da Alibaba Cloud especificado, como Maximum, Minimum e Average. Para obter informações sobre como obter os valores válidos, consulte Monitoramento de serviços em nuvem. Nota Defina pelo menos um dos níveis de severidade de alerta: Critical, Warn ou Info. Para cada nível de severidade de alerta especificado, você deve definir todos os seguintes parâmetros: Statistics, ComparisonOperator, Threshold e Times.	Average
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. Valores válidos de N: 1 a 200.	KEEP_LAST_STATE
ContactGroups	string	Não	O grupo de contatos de alerta. Valores válidos de N: 1 a 200. Para obter informações sobre como obter o grupo de contatos de alerta, consulte DescribeContactGroupList.	ECS_Group
Labels	array<object>	Não	As chaves de tag da regra de alerta.
	object	Não	As chaves de tag da regra de alerta.
Key	string	Não	A chave de tag da regra de alerta. A tag é incluída nas notificações de alerta. Valores válidos de N: 1 a 200.	key1
Value	string	Não	O valor da tag da regra de alerta. A tag é incluída nas notificações de alerta. Valores válidos de N: 1 a 200.	value1
Options	string	Não	As configurações avançadas. Formato: {"key1":"value1","key2":"value2"}. Por exemplo, {"NotSendOK":true} especifica se deve enviar uma notificação de recuperação de alerta. A chave é NotSendOK e o valor é true (não enviar) ou false (enviar, que é o padrão).	{ "NotSendOK": 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
Code	integer	O código de status. Nota Um valor 200 indica sucesso.	200
Message	string	A mensagem de erro.	The Request is not authorization.
RequestId	string	O ID da solicitação.	461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D
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
AlertResult	array<object>	A lista de regras de alerta.
	object
Code	integer	The status code of the newly created alert rule. Nota A value of 200 indicates success.	200
Message	string	The error message of the newly created alert rule.	Metric not found.
Success	boolean	Indicates whether the alert rule is created. Valid values: true: The alert rule is created. false: The alert rule failed to be created.	true
RuleName	string	The name of the newly created alert rule.	ECS_Rule1
RuleId	string	The ID of the newly created alert rule.	456789

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Success": true,
  "Resources": {
    "AlertResult": [
      {
        "Code": 200,
        "Message": "Metric not found.",
        "Success": true,
        "RuleName": "ECS_Rule1",
        "RuleId": "456789"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	%s	%s
412	%s	%s
500	%s	%s
500	500	%s
403	%s	%s
404	%s	%s
409	%s	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.