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

Este tópico apresenta um exemplo de criação de regra de alerta para a métrica cpu_total do Elastic Compute Service (ECS) no grupo de aplicativos 17285****. O ID da regra é 123456, e o nome é Rule_test. O nível de alerta é Critical, com método estatístico Average. O operador de comparação do limiar é GreaterThanOrEqualToThreshold, e o valor do limiar é 90. O número de tentativas de alerta é 3. O resultado indica que a regra foi criada com o ID 123456.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	PutGroupMetricRule	Operação a ser executada. Defina o valor como PutGroupMetricRule.
GroupId	String	Sim	17285****	ID do grupo de aplicativos. Para obter o ID de um grupo de aplicativos, consulte DescribeMonitorGroups.
RuleId	String	Sim	123456	ID da regra de alerta. Ao criar uma regra de alerta para o grupo de aplicativos, insira o ID da regra. Ao modificar uma regra específica no grupo, obtenha previamente o ID correspondente. Para isso, consulte DescribeMetricRuleList.
Category	String	Não	ECS	Abreviação do nome do serviço em nuvem. Para obter a abreviação do nome de um serviço em nuvem, consulte `metricCategory` no parâmetro de resposta `Labels` da operação DescribeProjectMeta.
RuleName	String	Sim	Rule_01	Nome da regra de alerta. Ao criar uma regra de alerta para o grupo de aplicativos, insira o nome da regra. Ao modificar uma regra específica no grupo, obtenha previamente o nome correspondente. Para isso, consulte DescribeMetricRuleList.
Namespace	String	Sim	acs_ecs_dashboard	Namespace do serviço em nuvem. Para obter o namespace de um serviço em nuvem, consulte DescribeMetricMetaList ou Apêndice 1: Métricas.
MetricName	String	Sim	cpu_total	Nome da métrica. Para obter o nome de uma métrica, consulte DescribeMetricMetaList ou Apêndice 1: Métricas.
Dimensions	String	Não	[{"instanceId":"i-m5e1qg6uo38rztr4****"}]	Dimensão de primeiro nível da regra de alerta no grupo de aplicativos. Defina o valor como um conjunto de pares `chave:valor`. Exemplo: `{"userId":"120886317861"}` ou `{"instanceId":"i-m5e1qg6uo38rztr4"}`.
ExtraDimensionJson	String	Não	{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}	Dimensão de segundo ou terceiro nível da regra de alerta no grupo de aplicativos. Defina o valor como um conjunto de pares `chave:valor`. Exemplo: `port:80` ou `/dev/xvda:d-m5e6yphgzn3aprwu**`. Se a dimensão de primeiro nível for `{"instanceId":"i-m5e1qg6uo38rztr4"}`, a dimensão de segundo nível corresponderá ao disco `{"/dev/xvda":"d-m5e6yphgzn3aprwu**"}` na instância.
EffectiveInterval	String	Não	05:31-23:59	Período de vigência da regra de alerta.
NoEffectiveInterval	String	Não	00:00-05:30	Período de inatividade da regra de alerta.
SilenceTime	Integer	Não	86400	Período de silêncio em que novas notificações de alerta não são enviadas, mesmo se as condições de acionamento forem atendidas. Unidade: segundos. Valor padrão: 86400.
Period	String	Não	60	Período de agregação dos dados da métrica. Defina o parâmetro `Period` como um múltiplo inteiro de 60. Unidade: segundos. Valor padrão: 300.
Interval	String	Não	60	Intervalo em que o CloudMonitor verifica se a regra de alerta foi acionada. Unidade: segundos. Nota Recomendamos definir o intervalo igual ao período de agregação de dados. Se o intervalo for menor que o período de agregação, os alertas poderão não ser acionados devido à insuficiência de dados.
Webhook	String	Não	https://www.aliyun.com	URL de callback. A URL de callback deve ser acessível pela Internet. O CloudMonitor envia uma solicitação POST para encaminhar a notificação de alerta à URL especificada. Somente solicitações HTTP são suportadas.
EmailSubject	String	Não	Instância ECS	Assunto do e-mail de notificação de alerta.
ContactGroups	String	Não	ECS_Group	Grupos de contatos de alerta.
Escalations.Critical.Statistics	String	Não	Average	Métodos estatísticos para alertas de nível Critical. Separe vários métodos com vírgulas (,). O valor deste parâmetro depende da coluna `Statistics` correspondente ao parâmetro `MetricName` do serviço em nuvem especificado. Os valores válidos são Maximum, Minimum ou Average. Para mais informações, consulte Apêndice 1: Métricas.
Escalations.Critical.ComparisonOperator	String	Não	GreaterThanOrEqualToThreshold	Operador de comparação entre o valor da métrica e o limiar para alertas de nível Critical. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual ao limiar GreaterThanThreshold: maior que o limiar LessThanOrEqualToThreshold: menor ou igual ao limiar LessThanThreshold: menor que o limiar NotEqualToThreshold: diferente do limiar 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
Escalations.Critical.Threshold	String	Não	90	Limiar para alertas de nível Critical.
Escalations.Critical.Times	Integer	Não	3	Número consecutivo de vezes em que o valor da métrica deve atender à condição de alerta antes de acionar um alerta de nível Critical.
Escalations.Warn.Statistics	String	Não	Average	Métodos estatísticos para alertas de nível Warn. Separe vários métodos com vírgulas (,). O valor deste parâmetro depende da coluna `Statistics` correspondente ao parâmetro `MetricName` do serviço em nuvem especificado. Os valores válidos são Maximum, Minimum ou Average. Para mais informações, consulte Apêndice 1: Métricas.
Escalations.Warn.ComparisonOperator	String	Não	GreaterThanOrEqualToThreshold	Operador de comparação entre o valor da métrica e o limiar para alertas de nível Warn. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual ao limiar GreaterThanThreshold: maior que o limiar LessThanOrEqualToThreshold: menor ou igual ao limiar LessThanThreshold: menor que o limiar NotEqualToThreshold: diferente do limiar 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
Escalations.Warn.Threshold	String	Não	90	Limiar para alertas de nível Warn.
Escalations.Warn.Times	Integer	Não	3	Número consecutivo de vezes em que o valor da métrica deve atender à condição de alerta antes de acionar um alerta de nível Warn.
Escalations.Info.Statistics	String	Não	Average	Métodos estatísticos para alertas de nível Info. Separe vários métodos com vírgulas (,). O valor deste parâmetro depende da coluna `Statistics` correspondente ao parâmetro `MetricName` do serviço em nuvem especificado. Os valores válidos são Maximum, Minimum ou Average. Para mais informações, consulte Apêndice 1: Métricas.
Escalations.Info.ComparisonOperator	String	Não	GreaterThanOrEqualToThreshold	Operador de comparação entre o valor da métrica e o limiar para alertas de nível Info. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual ao limiar GreaterThanThreshold: maior que o limiar LessThanOrEqualToThreshold: menor ou igual ao limiar LessThanThreshold: menor que o limiar NotEqualToThreshold: diferente do limiar 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
Escalations.Info.Threshold	String	Não	90	Limiar para alertas de nível Info.
Escalations.Info.Times	Integer	Não	3	Número consecutivo de vezes em que o valor da métrica deve atender à condição de alerta antes de acionar um alerta de nível Info.
NoDataPolicy	String	Não	KEEP_LAST_STATE	Método de tratamento de alertas quando não há dados de monitoramento. Valores válidos: KEEP_LAST_STATE (padrão): Nenhuma operação é executada. INSUFFICIENT_DATA: Aciona um alerta com o conteúdo "Insufficient data". OK: Considera o status normal.
Labels.N.Key	String	Não	key1	Chave da tag da regra de alerta.
Labels.N.Value	String	Não	value1	Valor da tag da regra de alerta.

Para mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	200	Código de status HTTP. Nota O código de status 200 indica que a solicitação foi bem-sucedida.
Message	String	The Request is not authorization.	Mensagem de erro.
RequestId	String	461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D	ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Result	Object		Resultado da solicitação.
RuleId	String	123456	ID da regra de alerta.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=PutGroupMetricRule
&Category=ECS
&GroupId=17285****
&MetricName=cpu_total
&Namespace=acs_ecs_dashboard
&RuleId=123456
&RuleName=`Rule_test
&Escalations.Critical.Statistics=Average
&Escalations.Critical.ComparisonOperator=GreaterThanOrEqualToThreshold
&Escalations.Critical.Threshold=90
&Escalations.Critical.Times=3
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<PutGroupMetricRuleResponse>
	<Message></Message>
	<RequestId>461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D</RequestId>
	<Code>200</Code>
	<Success>true</Success>
	<Result>
		<RuleId>123456</RuleId>
	</Result>
</PutGroupMetricRuleResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.