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.	xm_create_test
Owner	string	Sim	O ID da conta Alibaba Cloud usada pelo proprietário da regra.	279114181****
Enabled	boolean	Sim	Indica se a regra está ativada.	true
TriggerCondition	object	Sim	A condição de acionamento do alerta.
Type	string	Não	O tipo de alerta. Valores válidos: Finished: Uma instância é executada com sucesso. UnFinished: Uma instância não termina a execução antes de um ponto no tempo especificado. Error: Ocorre um erro em uma instância. CycleUnfinished: Uma instância não termina a execução conforme o esperado dentro de um ciclo específico. Timeout: O tempo de uma instância esgota. InstanceTransferComplete: Uma instância é gerada pelo nó acionado automaticamente. InstanceTransferFluctuate: O número de instâncias geradas flutua. ExhaustedError: Um erro persiste após uma instância ser reexecutada automaticamente. InstanceKeyword: Uma instância com erros contém palavras-chave especificadas. InstanceErrorCount: O número de instâncias nas quais ocorre um erro atinge um limite especificado. InstanceErrorPercentage: A proporção de instâncias nas quais ocorre um erro no workspace em relação ao número total de instâncias atinge um limite especificado. ResourceGroupPercentage: A taxa de uso do grupo de recursos atinge um limite especificado. ResourceGroupWaitCount: O número de instâncias que estão aguardando recursos no grupo de recursos atinge um limite especificado.	Error
Extension	object	Não	As informações estendidas sobre a regra. Este parâmetro é obrigatório para tipos específicos de alertas.
Error	object	Não	A configuração para um alerta do tipo Error.
StreamTaskIds	array	Não	The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.
	integer	Não	The ID of the real-time computing task.	123
AutoRerunAlertEnabled	boolean	Não	Specifies whether to trigger an alert if a batch synchronization task is automatically rerun upon a failure.	false
Timeout	object	Não	A configuração para um alerta do tipo Timeout.
TimeoutInMinutes	integer	Não	The timeout period. Unit: minutes. Valid values: [1, 21600].	10
UnFinished	object	Não	A configuração para um alerta do tipo UnFinished.
UnFinishedTime	string	Não	The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].	30:00
CycleUnfinished	object	Não	A configuração para um alerta do tipo CycleUnfinished.
CycleAndTime	array<object>	Não	The configurations of the scheduling cycle and timeout period of the instance.
	object	Não
CycleId	integer	Não	The ID of the scheduling cycle of the instance. Valid values: [1,288].	1
Time	string	Não	The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].	12:00
InstanceErrorCount	object	Não	A configuração para um alerta do tipo InstanceErrorCount.
Count	integer	Não	The maximum number of instances on which an error occurs. Valid values: [1,10000].	5
InstanceErrorPercentage	object	Não	A configuração para um alerta do tipo InstanceErrorPercentage.
Percentage	integer	Não	The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: [1-100].	5
InstanceTransferFluctuate	object	Não	A configuração para um alerta do tipo InstanceTransferFluctuate.
Trend	string	Não	The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values: abs: the absolute value. The number of instances increases or decreases. increase: The number of instances increases. decrease: The number of instances decreases.	abs
Percentage	integer	Não	The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: [1-100].	10
Target	object	Não	Os objetos monitorados.
Type	string	Não	O tipo dos objetos monitorados. Valores válidos: Task: nó Baseline: linha de base Project: workspace BizProcess: fluxo de trabalho.	Task
Ids	array	Não	Os IDs dos objetos monitorados.
	integer	Não	O ID do objeto monitorado.	123123
AllowTasks	array	Não	Os nós que não devem ser monitorados.
	integer	Não	O ID do nó que não deve ser monitorado.	123
Notification	object	Não	A configuração para a notificação de alerta.
SilenceStartTime	string	Não	O horário de início do silêncio. O horário está no formato HH:mm.	00:00
SilenceEndTime	string	Não	O horário de término do silêncio. O horário está no formato HH:mm.	00:00
IntervalInMinutes	integer	Não	O intervalo no qual uma notificação de alerta é enviada. Unidade: minutos. Valores válidos: [5,10000].	30
Maximum	integer	Não	O número máximo de vezes que uma notificação de alerta pode ser enviada dentro de um dia civil. Valores válidos: [1, 10000].	3
Channels	array	Sim	Os canais de notificação de alerta.
	string	Não	O canal de notificação de alerta. Valores válidos: Mail Phone Sms: mensagem de texto Dingding: DingTalk Feishu: Lark Weixin: 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: ID da conta Alibaba Cloud. Shift Schedules: a equipe em uma escala de turnos. TaskOwner: o proprietário da tarefa. O proprietário da tarefa pode receber alertas personalizados e alertas de eventos. Owner: o proprietário da linha de base. O proprietário da linha de base pode receber alertas de linha de base. WebhookUrl: URL de um webhook personalizado. DingdingUrl: URL do webhook do DingTalk. FeishuUrl: URL do webhook do Lark. WeixinUrl: URL do webhook do WeCom.	TaskOwner
ReceiverValues	array	Não	O ID do destinatário do alerta.
	string	Não	O ID do destinatário do alerta. Se o parâmetro ReceiverType estiver definido como AliUid, defina este parâmetro como um ID de conta Alibaba Cloud. Se o parâmetro ReceiverType estiver definido como ShiftSchedule, defina este parâmetro como um ID de escala de turnos. Se o parâmetro ReceiverType estiver definido como WebhookUrl, DingdingUrl, FeishuUrl ou WeixinUrl, defina este parâmetro como a URL correspondente.	123123123
Extension	string	Não	A configuração adicional do destinatário do alerta. Se o parâmetro ReceiverType estiver definido como DingdingUrl, você pode definir este parâmetro como {"atAll":true} para lembrar todos os membros em um grupo do DingTalk.	{"atAll":true}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	A6C6B486-E3A2-5D52-9E76-D9380485D946
Id	integer	O ID da regra.	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.