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

Aplica um modelo de alerta a um grupo de aplicações para gerar regras de alerta.

Descrição da operação

Este tópico fornece um exemplo para mostrar como aplicar o modelo de alerta 700**** ao grupo de aplicações 123456. O ID da regra de alerta gerada é applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08**** e o nome é test123.

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

create

*MetricRuleTemplate

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SilenceTime	integer	Não	O período de silenciamento. Unidade: segundos. Valor padrão: 86400. Nota Se os dados de monitoramento excederem continuamente o limite da regra de alerta, o sistema enviará apenas uma notificação de alerta dentro de cada período de silenciamento.	86400
GroupId	integer	Sim	O ID do grupo de aplicações. Para mais informações sobre como obter o ID de um grupo de aplicações, consulte DescribeMonitorGroups.	123456
TemplateIds	string	Sim	O ID do modelo de alerta. Para mais informações sobre como obter o ID de um modelo de alerta, consulte DescribeMetricRuleTemplateList.	700****
EnableStartTime	integer	Não	A hora de início do período de vigência da regra de alerta. O valor é uma string de dois dígitos, como "00", "09" ou "23". Valores válidos: 00 a 23, que representam 00:00 a 23:00. O fuso horário padrão é UTC+8.	00
EnableEndTime	integer	Não	A hora de término do período de vigência da regra de alerta. O valor é uma string de dois dígitos, como "00", "18" ou "23". Valores válidos: 00 a 23. O valor especifica a hora do horário de término, e o período de vigência termina no 59º minuto da hora. Por exemplo, "23" indica que o período de vigência termina às 23:59. O fuso horário padrão é UTC+8.	23
NotifyLevel	integer	Não	O método de notificação de alerta. Valores válidos: 4: TradeManager e chatbot do DingTalk.	4
ApplyMode	string	Não	O modo de aplicação do modelo. Valores válidos: GROUP_INSTANCE_FIRST: as instâncias no grupo de aplicações têm precedência. Ao aplicar o modelo de alerta, as instâncias no grupo de aplicações têm precedência. Se uma instância no modelo não existir no grupo de aplicações, a regra para a instância no modelo será ignorada. ALARM_TEMPLATE_FIRST: as instâncias no modelo de alerta têm precedência. Ao aplicar o modelo de alerta, as regras de alerta são criadas independentemente de as instâncias existirem ou não no grupo de aplicações.	GROUP_INSTANCE_FIRST
Webhook	string	Não	A URL do webhook para a qual uma solicitação POST é enviada quando um alerta é acionado.	https://www.aliyun.com
AppendMode	string	Não	A política de aplicação do modelo. Valores válidos: all: exclui todas as regras criadas usando modelos de alerta para os grupos de aplicações selecionados e, em seguida, cria regras de alerta com base no modelo atual. Este é o valor padrão. append: exclui as regras criadas usando o modelo de alerta atual para os grupos de aplicações selecionados e, em seguida, cria regras de alerta com base no modelo atual.	all
DryRun	boolean	Não	Especifica se deve ser realizado um dry run na solicitação. Valores válidos: true: realiza um dry run e não vincula um grupo de segurança a uma instância. 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 foram atendidos. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro DryRunOperation será retornado. false: realiza um dry run e envia a solicitação. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado e a operação será executada. Este é o valor padrão.	false

Para 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 HTTP. Nota Um código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem de erro.	The specified resource is not found.
RequestId	string	O ID da solicitação.	3F897F3C-020A-4993-95B4-63ABB84F83E6
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
Resource	object	Os recursos afetados pela regra de alerta.
GroupId	integer	O ID do grupo de aplicações.	123456
AlertResults	array<object>	Os resultados detalhados das regras de alerta geradas.
	object	Os resultados detalhados das regras de alerta geradas.
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 retornada.	alert rule is creating, please wait a few minutes.
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
RuleName	string	O nome da regra de alerta.	test123
RuleId	string	O ID da regra de alerta.	applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "The specified resource is not found.",
  "RequestId": "3F897F3C-020A-4993-95B4-63ABB84F83E6",
  "Success": true,
  "Resource": {
    "GroupId": 123456,
    "AlertResults": [
      {
        "Code": "200",
        "Message": "alert rule is creating, please wait a few minutes.",
        "Success": true,
        "RuleName": "test123",
        "RuleId": "applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ParameterInvalid	Illegal parameters.
412	DryRunOperation	%s.	O resultado da pré-verificação de dry run.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.