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

Cria uma regra de alerta para uma tarefa de integração de dados.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar este recurso.

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
Description	string	Não	A descrição da regra de alerta.	Alert description
MetricType	string	Sim	O tipo de métrica de alerta. Valores válidos: Heartbeat: alerta de status da tarefa. FailoverCount: alerta de contagem de failover. Delay: alerta de latência da tarefa. DdlReport: notificação de DDL. ResourceUtilization: utilização do grupo de recursos.	Heartbeat
Enabled	boolean	Não	Especifica se a regra de alerta deve ser ativada. Por padrão, a regra de alerta é desativada.	true
DIJobId	integer	Sim	O ID da tarefa associada à regra de alerta.	1
ClientToken	string	Não	O parâmetro de idempotência.	ABFUOEUOTRTRJKE
Name	string	Sim	O nome da regra de alerta.	alartRule
TriggerConditions	array<object>	Sim	A lista de condições de acionamento de alerta. Várias condições são suportadas.
	object	Não	A lista de condições de acionamento de alerta. Várias condições são suportadas.
Severity	string	Não	O nível de severidade. Valores válidos: Warning Critical	Warning
Duration	integer	Não	A janela de tempo para cálculo do alerta. Unidade: minutos.	10
Threshold	integer	Não	O limite de alerta. Alerta de status da tarefa: nenhum limite é necessário. Alerta de contagem de failover: o limite é o número de failovers. Alerta de latência da tarefa: o limite é a duração da latência. Unidade: segundos.	10
DdlTypes	array	Não	A lista de tipos de DDL que entram em vigor. Este parâmetro só tem efeito quando o tipo de métrica é notificação de DDL.
	string	Não	A lista de tipos de DDL que entram em vigor. Este parâmetro é retornado apenas quando MetricType está definido como DdlReport. Valores válidos: AlterAddColumn: adicionar uma coluna. AlterDropColumn: remover uma coluna. AlterRenameColumn: renomear uma coluna. AlterRenameTable: renomear uma tabela. AlterTableModify: outras modificações de tabela. DropTable: remover uma tabela. TruncateTable: truncar uma tabela.	AlterAddColumn
DdlReportTags `deprecated`	array	Não	[Deprecated] Use o parâmetro DdlTypes em vez disso.
`deprecated`	string	Não	[Deprecated] Use o parâmetro DdlTypes em vez disso.	AlterAddColumn
NotificationSettings	object	Sim	As configurações de notificação de alerta.
NotificationChannels	array<object>	Não	Os canais de notificação de alerta.
	object	Não	Os canais de notificação de alerta.
Severity	string	Não	O nível de severidade. Valores válidos: Warning Critical	Warning
Channels	array	Não	O canal de notificação. Valores válidos: Mail: e-mail. Phone: chamada telefônica. Sms: mensagem de texto. Ding: DingTalk.
	string	Não	O canal de notificação. Valores válidos: Mail: e-mail. Phone: chamada telefônica. Sms: mensagem de texto. Ding: DingTalk.	Ding
NotificationReceivers	array<object>	Não	Os destinatários da notificação de alerta.
	object	Não	Os destinatários da notificação de alerta.
ReceiverType	string	Não	O tipo de destinatário. Valores válidos: AliyunUid, DingToken, FeishuToken e WebHookUrl.	DingToken
ReceiverValues	array	Não	Os valores dos destinatários. Se o tipo de destinatário for AliyunUid, o valor é o ID da conta Alibaba Cloud. Se o tipo de destinatário for DingToken, o valor é o token do DingTalk.
	string	Não	Os valores dos destinatários. Se o tipo de destinatário for AliyunUid, o valor é o ID da conta Alibaba Cloud. Se o tipo de destinatário for DingToken, o valor é o token do DingTalk.	token1
MuteInterval	integer	Não	O intervalo de silenciamento do alerta. Unidade: minutos. Valor padrão: 5.	5
InhibitionInterval `deprecated`	integer	Não	[Deprecated] Use o parâmetro MuteInterval em vez disso.	5

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Id	integer	O ID da regra de alerta.	1
RequestId	string	O ID da solicitação. Usado para localizar logs e solucionar problemas.	C636A747-7E4E-594D-94CD-2B****
DIAlarmRuleId `deprecated`	string	[Deprecated] Use o parâmetro Id em vez disso.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "Id": 1,
  "RequestId": "C636A747-7E4E-594D-94CD-2B****",
  "DIAlarmRuleId": "1"
}

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.