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

Cria ou modifica uma regra de alerta em um grupo de aplicativos especificado.

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 servidor do serviço da Alibaba Cloud Elastic Computing Service no grupo de aplicativos 17285****. O ID da regra de alerta é 123456, o nome da regra de alerta é Rule_test, o nível de alerta é Critical, o método estatístico é Average, o operador de comparação de limite é GreaterThanOrEqualToThreshold, o limite é 90 e a contagem de tentativas é 3. A resposta mostra que a regra de alerta foi criada e o ID da regra de alerta é 123456.

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

create

*GroupMetricRule

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	string	Sim	O ID do grupo de aplicativos. Para obter mais informações sobre como obter o ID de um grupo de aplicativos, consulte DescribeMonitorGroups.	17285****
RuleId	string	Sim	O ID da regra de alerta. Para criar uma regra de alerta para o grupo de aplicativos, insira um ID de regra de alerta. Para modificar uma regra de alerta especificada no grupo de aplicativos, você deve obter o ID da regra de alerta. Para obter mais informações sobre como obter o ID de uma regra de alerta, consulte DescribeMetricRuleList.	123456
Category	string	Não	A abreviação do nome do serviço da Alibaba Cloud. Para obter mais informações sobre como obter a abreviação do nome de um serviço da Alibaba Cloud, consulte o campo `metricCategory` no parâmetro de resposta `Labels` da operação DescribeProjectMeta.	ECS
RuleName	string	Sim	O nome da regra de alerta. Para criar uma regra de alerta para o grupo de aplicativos, insira um nome de regra de alerta. Para modificar uma regra de alerta especificada no grupo de aplicativos, você deve obter o nome da regra de alerta. Para obter mais informações sobre como obter o nome de uma regra de alerta, consulte DescribeMetricRuleList.	Rule_01
Namespace	string	Sim	O namespace do serviço da Alibaba Cloud. Para obter mais informações sobre como obter o namespace de um serviço da Alibaba Cloud, consulte DescribeMetricMetaList ou métricas de monitoramento de serviços em nuvem.	acs_ecs_dashboard
MetricName	string	Sim	O nome da métrica de monitoramento. Para obter mais informações sobre como obter o nome de uma métrica de monitoramento, consulte DescribeMetricMetaList ou métricas de monitoramento de serviços em nuvem.	cpu_total
Dimensions	string	Não	A dimensão de primeiro nível da regra de alerta no grupo de aplicativos. Formato: uma coleção de pares `chave:valor`. Exemplos: `{"userId":"120886317861**"}` e `{"instanceId":"i-m5e1qg6uo38rztr4**"}`.	[{"instanceId":"i-m5e1qg6uo38rztr4****"}]
ExtraDimensionJson	string	Não	A dimensão de segundo ou terceiro nível da regra de alerta no grupo de aplicativos. Formato: uma coleção de pares `chave:valor`. Exemplos: `port:80` e `/dev/xvda:d-m5e6yphgzn3aprwu**`. Se a dimensão de primeiro nível da regra de alerta for `{"instanceId":"i-m5e1qg6uo38rztr4"}`, a dimensão de segundo nível será o disco em nuvem na instância, como `{"/dev/xvda":"d-m5e6yphgzn3aprwu**"}`.	{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}
EffectiveInterval	string	Não	O período de vigência da regra de alerta.	05:31-23:59
NoEffectiveInterval	string	Não	O intervalo de tempo durante o qual a regra de alerta fica inativa.	00:00-05:30
SilenceTime	integer	Não	O período de silenciamento. Unidade: segundos. Valor padrão: 86400.	86400
Period	string	Não	O período de relatório dos dados de monitoramento. O valor de `Period` deve ser 60 ou um múltiplo de 60. Unidade: segundos. Valor padrão: 300.	60
Interval	string	Não	O período de detecção da regra de alerta. Unidade: segundos. Nota Defina o período de detecção da regra de alerta com o mesmo valor do 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 não poderão ser acionados devido à insuficiência de dados.	60
Webhook	string	Não	A URL do webhook que é chamada quando um alerta é acionado. Insira uma URL publicamente acessível. O CloudMonitor envia notificações de alerta para esta URL por meio de solicitações POST. Apenas HTTP é suportado.	https://www.aliyun.com
EmailSubject	string	Não	O assunto do e-mail de alerta.	ECS instance
ContactGroups	string	Não	Os grupos de contatos de alerta.	ECS_Group
Escalations.Critical.Statistics	string	Não	O método estatístico para alertas de nível Critical. Separe vários métodos estatísticos com vírgulas (,). Os valores válidos deste parâmetro são determinados pela coluna `Statistics` que corresponde ao `MetricName` do serviço da Alibaba Cloud especificado. Exemplos: Maximum, Minimum e Average. Para obter mais informações sobre como obter os valores válidos deste parâmetro, consulte métricas de monitoramento de serviços em nuvem.	Average
Escalations.Critical.ComparisonOperator	string	Não	O operador de comparação de limite 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 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
Escalations.Critical.Threshold	string	Não	O limite para alertas de nível Critical.	90
Escalations.Critical.Times	integer	Não	O número de tentativas para alertas de nível Critical.	3
Escalations.Warn.Statistics	string	Não	O método estatístico para alertas de nível Warn. Separe vários métodos estatísticos com vírgulas (,). Os valores válidos deste parâmetro são determinados pela coluna `Statistics` que corresponde ao `MetricName` do serviço da Alibaba Cloud especificado. Exemplos: Maximum, Minimum e Average. Para obter mais informações sobre como obter os valores válidos deste parâmetro, consulte métricas de monitoramento de serviços em nuvem.	Average
Escalations.Warn.ComparisonOperator	string	Não	O operador de comparação de limite 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 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
Escalations.Warn.Threshold	string	Não	O limite para alertas de nível Warn.	90
Escalations.Warn.Times	integer	Não	O número de tentativas para alertas de nível Warn.	3
Escalations.Info.Statistics	string	Não	O método estatístico para alertas de nível Info. Separe vários métodos estatísticos com vírgulas (,). Os valores válidos deste parâmetro são determinados pela coluna `Statistics` que corresponde ao `MetricName` do serviço da Alibaba Cloud especificado. Exemplos: Maximum, Minimum e Average. Para obter mais informações sobre como obter os valores válidos deste parâmetro, consulte métricas de monitoramento de serviços em nuvem.	Average
Escalations.Info.ComparisonOperator	string	Não	O operador de comparação de limite 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 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
Escalations.Info.Threshold	string	Não	O limite para alertas de nível Info.	90
Escalations.Info.Times	integer	Não	O número de tentativas para alertas de nível Info.	3
NoDataPolicy	string	Não	A ação a ser tomada quando nenhum dado de monitoramento for encontrado. Valores válidos: KEEP_LAST_STATE: Não executa nenhuma ação. Este é o valor padrão. INSUFFICIENT_DATA: Envia uma notificação de alerta indicando que nenhum dado foi encontrado. OK: Envia uma notificação de alerta indicando que o status está normal.	KEEP_LAST_STATE
Labels	array<object>	Não	As tags da regra de alerta. As notificações de alerta incluem as tags.
	object	Não	Nenhuma.
Key	string	Não	A chave da tag da regra de alerta.	key1
Value	string	Não	O valor da tag da regra de alerta.	value1
Options	string	Não	As configurações avançadas. Formato: `{"key1":"value1","key2":"value2"}`. Exemplo: `{"NotSendOK":true}`, que especifica se devem ser enviadas notificações de recuperação de alerta. A chave é `NotSendOK` e o valor é `true` (não enviar) ou `false` (enviar, que é o padrão).	{"NotSendOK":true}
DryRun	boolean	Não	Especifica se deve ser realizada apenas uma pré-verificação da solicitação. Valores válidos: true: envia uma solicitação de verificação e não executa a operação real. O sistema verifica se os parâmetros obrigatórios foram especificados, se o formato da solicitação é válido e se os limites do serviço são atendidos. Se a verificação falhar, o sistema retornará um erro. Se a verificação for bem-sucedida, o sistema retornará o código de erro `DryRunOperation`. false: envia uma solicitação normal. Se a verificação for bem-sucedida, o sistema retornará um código de status HTTP 2xx e executará a operação. Este é o valor padrão.	false

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	Nenhuma.
Code	string	O código de status HTTP. Nota Um código de status 200 indica que a solicitação foi bem-sucedida.	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
Result	object	O resultado da criação ou modificação da regra de alerta.
RuleId	string	O ID da regra de alerta.	123456

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Success": true,
  "Result": {
    "RuleId": "123456"
  }
}

Códigos de erro

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