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

Cria um modelo de alerta.

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

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Sim	O nome do modelo de alerta.	Template1
Description	string	Não	A descrição do modelo de alerta.	ECS_Template1
AlertTemplates	array<object>	Não	Os detalhes do modelo de alerta.
	object	Não	O modelo de alerta.
Escalations.Info.Threshold	string	Não	O limite para alertas de nível Info. Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	20
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 de uma métrica, consulte DescribeMetricMetaList ou Metrics.	cpu_total
Webhook	string	Não	A URL de callback. Valores válidos de N: 1 a 200. A URL de callback deve estar acessível pela Internet. O CloudMonitor envia uma notificação de alerta para a URL de callback especificada enviando uma solicitação HTTP POST. Apenas o protocolo HTTP é suportado.	http://ww.aliyun.com
Escalations.Warn.Threshold	string	Não	O limite para alertas de nível Warn. Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	30
Namespace	string	Sim	O namespace do serviço de nuvem. Valores válidos de N: 1 a 200. Para obter informações sobre como obter o namespace de um serviço de nuvem, consulte DescribeMetricMetaList ou Apêndice 1: Métricas.	acs_ecs_dashboard
Period	integer	Não	O período de agregação dos dados de monitoramento. Unidade: segundos. O valor padrão é o período mínimo de agregação. Geralmente, você não precisa especificar o período mínimo de agregação. Valores válidos de N: 1 a 200.	60
RuleName	string	Sim	O nome da regra de alerta. Valores válidos de N: 1 a 200.	ECS_Rule1
Escalations.Critical.Times	integer	Não	O número consecutivo de vezes em que o valor da métrica atende à condição de alerta antes que um alerta de nível Critical seja acionado. Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	3
Selector	string	Não	A dimensão do alerta. É um campo estendido. Valores válidos de N: 1 a 200. Por exemplo, se um modelo de alerta for aplicado a um grupo de aplicações, este parâmetro for definido como `{"disk":"/"}` e o parâmetro MetricName for definido como `DiskUtilization`. Nesse caso, a regra de alerta gerada é aplicada à partição de disco raiz (`"/"`) de todas as instâncias no grupo de aplicações ao qual o modelo de alerta é aplicado. Nota Para obter mais informações sobre os valores dos campos estendidos, consulte DescribeMetricRuleTemplateAttribute.	{"disk":"/"}
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. O valor deste parâmetro é determinado pela coluna `Statistics` correspondente ao parâmetro `MetricName` do serviço de nuvem especificado. O valor deste parâmetro pode ser Maximum, Minimum ou Average. Para obter mais informações sobre como obter o valor deste parâmetro, consulte Apêndice 1: Métricas. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	Average
Escalations.Warn.Times	integer	Não	O número consecutivo de vezes em que o valor da métrica atende à condição de alerta antes que um alerta de nível Warn seja acionado. Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	1
Escalations.Info.ComparisonOperator	string	Não	O operador usado para comparar o valor da métrica com o 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 da métrica no mesmo horário de ontem LessThanYesterday: menor que o valor da métrica no mesmo horário de ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário da semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário da semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no ciclo de monitoramento anterior Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	GreaterThanOrEqualToThreshold
Category	string	Sim	A abreviação do nome do serviço de nuvem. Valores válidos de N: 1 a 200. Para obter mais informações sobre como obter a abreviação do nome de um serviço de nuvem, consulte `metricCategory` no parâmetro de resposta `Labels` da operação DescribeProjectMeta.	ecs
Escalations.Critical.Threshold	string	Não	O limite para alertas de nível Critical. Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	30
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. O valor deste parâmetro é determinado pela coluna `Statistics` correspondente ao parâmetro `MetricName` do serviço de nuvem especificado. O valor deste parâmetro pode ser Maximum, Minimum ou Average. Para obter mais informações sobre como obter o valor deste parâmetro, consulte Apêndice 1: Métricas. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	Average
Escalations.Critical.ComparisonOperator	string	Não	O operador usado para comparar o valor da métrica com o 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 da métrica no mesmo horário de ontem LessThanYesterday: menor que o valor da métrica no mesmo horário de ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário da semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário da semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no ciclo de monitoramento anterior Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	GreaterThanOrEqualToThreshold
Escalations.Warn.ComparisonOperator	string	Não	O operador usado para comparar o valor da métrica com o 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 da métrica no mesmo horário de ontem LessThanYesterday: menor que o valor da métrica no mesmo horário de ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário da semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário da semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no ciclo de monitoramento anterior Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	GreaterThanOrEqualToThreshold
Escalations.Info.Times	integer	Não	O número consecutivo de vezes em que o valor da métrica atende à condição de alerta antes que um alerta de nível Info seja acionado. Valores válidos de N: 1 a 200. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	1
Escalations.Warn.Statistics	string	Não	O método estatístico para o alerta de nível Warn. Valores válidos de N: 1 a 200. O valor deste parâmetro é determinado pela coluna `Statistics` correspondente ao parâmetro `MetricName` do serviço de nuvem especificado. O valor deste parâmetro pode ser Maximum, Minimum ou Average. Para obter mais informações sobre como obter o valor deste parâmetro, consulte Apêndice 1: Métricas. Nota Você deve selecionar pelo menos um dos níveis de alerta Critical, Warn e Info e especificar os parâmetros Statistics, ComparisonOperator, Threshold e Times para cada nível de alerta.	Average

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
Code	integer	O código de status. Nota O 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.	9763ED1A-4D09-41BF-851E-310421750204
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
Id	integer	O ID do modelo de alerta.	12345

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "9763ED1A-4D09-41BF-851E-310421750204",
  "Success": true,
  "Id": 12345
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
412	ResourcesOverLimit	Resources over limit.
500	InternalFailure	%s
402	LimitExceeded	The quota for this customer had been reached.
403	InvalidClientTokenId	not allow this operation.	No permission
206	%s	%s
503	%s	%s
406	%s	%s
429	Throttli∂ngException	The request was denied due to request throttling.
409	%s	%s
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.