CreateAlertRule - DataWorks: Central de Documentação do Alibaba Cloud

Cria uma regra de alerta de monitoramento personalizado.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Sim	O nome da regra personalizada.	xm_create_test
Owner	string	Sim	O UID do Alibaba Cloud do proprietário da regra personalizada.	279114181****
Enabled	boolean	Sim	Especifica se a regra de alerta está ativada.	true
TriggerCondition	object	Sim	A condição que aciona o alerta.
Type	string	Não	O tipo de acionamento do alerta. Valores válidos: Finished: Instância concluída. UnFinished: Instância não concluída. Error: Erro de instância. CycleUnfinished: Ciclo da instância não concluído. Timeout: Tempo limite da instância. InstanceTransferComplete: Conversão de nó para instância concluída. InstanceTransferFluctuate: Flutuação na contagem de instâncias. ExhaustedError: O erro persiste após novas execuções automáticas. InstanceKeyword: A instância com erro contém a palavra-chave. InstanceErrorCount: Número de instâncias com erro. InstanceErrorPercentage: Porcentagem de instâncias com erro. ResourceGroupPercentage: Utilização do grupo de recursos. ResourceGroupWaitCount: Número de instâncias aguardando recursos no grupo de recursos.	Error
Extension	object	Não	As informações de extensão. Este parâmetro é obrigatório para determinadas configurações de condição de acionamento.
Error	object	Não	A configuração de alerta de erro.
StreamTaskIds	array	Não	Os IDs das tarefas de computação em tempo real a serem monitoradas.
	integer	Não	O ID de uma tarefa de computação em tempo real.	123
AutoRerunAlertEnabled	boolean	Não	Especifica se deve ser gerado um alerta quando uma tarefa offline for executada novamente de forma automática devido a uma falha.	false
Timeout	object	Não	A configuração de alerta de tempo limite.
TimeoutInMinutes	integer	Não	A duração do tempo limite, em minutos. Valores válidos: 1 a 21600.	10
UnFinished	object	Não	A configuração de alerta de não conclusão.
UnFinishedTime	string	Não	O tempo de não conclusão, no formato hh:mm. Valores válidos de hh: 0 a 47. Valores válidos de mm: 0 a 59.	30:00
CycleUnfinished	object	Não	A configuração de alerta de ciclo não concluído.
CycleAndTime	array<object>	Não	A lista de configurações de ciclo e tempo.
	object	Não
CycleId	integer	Não	O ID do ciclo. Valores válidos: 1 a 288.	1
Time	string	Não	O tempo limite, no formato hh:mm. Valores válidos de hh: 0 a 47. Valores válidos de mm: 0 a 59.	12:00
InstanceErrorCount	object	Não	A configuração de alerta de contagem de erros de instância.
Count	integer	Não	O número de instâncias com erro. Valores válidos: 1 a 10000.	5
InstanceErrorPercentage	object	Não	A configuração de alerta de porcentagem de erros de instância.
Percentage	integer	Não	A porcentagem de instâncias com erro. Valores válidos: 1 a 100.	5
InstanceTransferFluctuate	object	Não	A configuração de alerta de flutuação de transferência de instância.
Trend	string	Não	O tipo de flutuação de transferência de instância. Valores válidos: abs: valor absoluto increase: aumento decrease: diminuição	abs
Percentage	integer	Não	A porcentagem de flutuação de transferência de instância. Valores válidos: 1 a 100.	10
Target	object	Não	O objeto monitorado.
Type	string	Não	O tipo de objeto monitorado. Valores válidos: Task: nó Baseline: linha de base Project: espaço de trabalho BizProcess: processo de negócios	Task
Ids	array	Não	A lista de IDs de objetos monitorados.
	integer	Não	O ID do objeto monitorado.	123123
AllowTasks	array	Não	A lista de permissões de tarefas monitoradas.
	integer	Não	O ID de uma tarefa monitorada na lista de permissões.	123
Notification	object	Não	A configuração de notificação de alerta.
SilenceStartTime	string	Não	A hora de início do período de silêncio do alerta, no formato HH:mm.	00:00
SilenceEndTime	string	Não	A hora de término do período de silêncio do alerta, no formato HH:mm.	00:00
IntervalInMinutes	integer	Não	O intervalo de alerta, em minutos. Valores válidos: 5 a 10000.	30
Maximum	integer	Não	O número máximo de alertas em um dia civil. Valores válidos: 1 a 10000.	3
Channels	array	Sim	A lista de canais de alerta.
	string	Não	O canal de alerta. Valores válidos: Mail: e-mail Phone: chamada telefônica Sms: mensagem de texto Dingding: webhook do DingTalk Feishu: webhook do Lark Weixin: webhook do WeCom Webhook: webhook personalizado	Sms
Receivers	array<object>	Sim	Os destinatários do alerta.
	object	Não
ReceiverType	string	Não	O tipo de destinatário do alerta. Valores válidos: AliUid: UID do Alibaba Cloud ShiftSchedule: escala de turnos TaskOwner: proprietário do nó, aplicável a alertas personalizados e alertas de eventos Owner: proprietário, aplicável a alertas de linha de base WebhookUrl: URL de webhook personalizado DingdingUrl: URL de webhook do DingTalk FeishuUrl: URL de webhook do Lark WeixinUrl: URL de webhook do WeCom	TaskOwner
ReceiverValues	array	Não	Os valores do destinatário do alerta.
	string	Não	O valor do destinatário do alerta. Se ReceiverType for AliUid, especifique o UID do Alibaba Cloud. Se ReceiverType for ShiftSchedule, especifique o ID da escala de turnos. Se ReceiverType for WebhookUrl, DingdingUrl, FeishuUrl ou WeixinUrl, especifique a URL correspondente.	123123123
Extension	string	Não	A configuração adicional necessária para o destinatário do alerta. Se ReceiverType for DingdingUrl, você pode definir {"atAll":true} para @ todos os membros.	{"atAll":true}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação, que é usado para localizar logs e solucionar problemas.	A6C6B486-E3A2-5D52-9E76-D9380485D946
Id	integer	O ID da regra personalizada.	123123

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D9380485D946\n",
  "Id": 123123
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.