CreateAlertRule - DataWorks - Centro de documentación de Alibaba Cloud

Crea una regla de alerta de monitoreo personalizada.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Name	string	Sí	El nombre de la regla personalizada.	xm_create_test
Owner	string	Sí	El UID de Alibaba Cloud del propietario de la regla personalizada.	279114181****
Enabled	boolean	Sí	Especifica si la regla de alerta está habilitada.	true
TriggerCondition	object	Sí	La condición que activa la alerta.
Type	string	No	El tipo de activador de alerta. Valores válidos: Finished: instancia finalizada. UnFinished: instancia no finalizada. Error: error de instancia. CycleUnfinished: ciclo de instancia no finalizado. Timeout: tiempo de espera de instancia agotado. InstanceTransferComplete: conversión de nodo a instancia finalizada. InstanceTransferFluctuate: fluctuación de la cantidad de instancias. ExhaustedError: el error persiste después de reejecuciones automáticas. InstanceKeyword: la instancia con error contiene una palabra clave. InstanceErrorCount: número de instancias con error. InstanceErrorPercentage: porcentaje de instancias con error. ResourceGroupPercentage: utilización del grupo de recursos. ResourceGroupWaitCount: número de instancias en espera de recursos en el grupo de recursos.	Error
Extension	object	No	La información de extensión. Este parámetro es obligatorio para determinadas configuraciones de condición de activación.
Error	object	No	La configuración de alerta de errores.
StreamTaskIds	array	No	Los ID de las tareas de computación en tiempo real que se van a monitorear.
	integer	No	El ID de una tarea de computación en tiempo real.	123
AutoRerunAlertEnabled	boolean	No	Especifica si se debe generar una alerta cuando una tarea sin conexión se reejecuta automáticamente debido a un error.	false
Timeout	object	No	La configuración de alerta de tiempo de espera.
TimeoutInMinutes	integer	No	La duración del tiempo de espera, en minutos. Valores válidos: de 1 a 21600.	10
UnFinished	object	No	La configuración de alerta de no finalización.
UnFinishedTime	string	No	La hora de no finalización, en formato hh:mm. Valores válidos para hh: de 0 a 47. Valores válidos para mm: de 0 a 59.	30:00
CycleUnfinished	object	No	La configuración de alerta de ciclo no finalizado.
CycleAndTime	array<object>	No	La lista de configuraciones de ciclo y hora.
	object	No
CycleId	integer	No	El ID del ciclo. Valores válidos: de 1 a 288.	1
Time	string	No	La hora de tiempo de espera, en formato hh:mm. Valores válidos para hh: de 0 a 47. Valores válidos para mm: de 0 a 59.	12:00
InstanceErrorCount	object	No	La configuración de alerta de número de instancias con error.
Count	integer	No	El número de instancias con error. Valores válidos: de 1 a 10000.	5
InstanceErrorPercentage	object	No	La configuración de alerta de porcentaje de instancias con error.
Percentage	integer	No	El porcentaje de instancias con error. Valores válidos: de 1 a 100.	5
InstanceTransferFluctuate	object	No	La configuración de alerta de fluctuación de la cantidad de instancias.
Trend	string	No	El tipo de fluctuación de la cantidad de instancias. Valores válidos: abs: valor absoluto increase: aumento decrease: disminución	abs
Percentage	integer	No	El porcentaje de fluctuación de la cantidad de instancias. Valores válidos: de 1 a 100.	10
Target	object	No	El objeto monitoreado.
Type	string	No	El tipo de objeto monitoreado. Valores válidos: Task: nodo Baseline: línea base Project: espacio de trabajo BizProcess: proceso de negocio	Task
Ids	array	No	La lista de ID de objetos monitoreados.
	integer	No	El ID del objeto monitoreado.	123123
AllowTasks	array	No	La lista blanca de tareas monitoreadas.
	integer	No	El ID de una tarea monitoreada en la lista blanca.	123
Notification	object	No	La configuración de notificación de alerta.
SilenceStartTime	string	No	La hora de inicio del período de silencio de alerta, en formato HH:mm.	00:00
SilenceEndTime	string	No	La hora de finalización del período de silencio de alerta, en formato HH:mm.	00:00
IntervalInMinutes	integer	No	El intervalo de alerta, en minutos. Valores válidos: de 5 a 10000.	30
Maximum	integer	No	El número máximo de alertas en un día natural. Valores válidos: de 1 a 10000.	3
Channels	array	Sí	La lista de canales de alerta.
	string	No	El canal de alerta. Valores válidos: Mail: correo electrónico Phone: llamada telefónica Sms: mensaje de texto Dingding: webhook de DingTalk Feishu: webhook de Lark Weixin: webhook de WeCom Webhook: webhook personalizado	Sms
Receivers	array<object>	Sí	Los destinatarios de alerta.
	object	No
ReceiverType	string	No	El tipo de destinatario de alerta. Valores válidos: AliUid: UID de Alibaba Cloud ShiftSchedule: programación de turnos TaskOwner: propietario del nodo, aplicable a alertas personalizadas y alertas de eventos Owner: propietario, aplicable a alertas de línea base WebhookUrl: URL de webhook personalizado DingdingUrl: URL de webhook de DingTalk FeishuUrl: URL de webhook de Lark WeixinUrl: URL de webhook de WeCom	TaskOwner
ReceiverValues	array	No	Los valores del destinatario de alerta.
	string	No	El valor del destinatario de alerta. Si ReceiverType es AliUid, especifique el UID de Alibaba Cloud. Si ReceiverType es ShiftSchedule, especifique el ID de la programación de turnos. Si ReceiverType es WebhookUrl, DingdingUrl, FeishuUrl o WeixinUrl, especifique la URL correspondiente.	123123123
Extension	string	No	La configuración adicional requerida para el destinatario de alerta. Si ReceiverType es DingdingUrl, puede establecer {"atAll":true} para mencionar a todos los miembros.	{"atAll":true}

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de respuesta.
RequestId	string	El ID de la solicitud, que se usa para localizar registros y solucionar problemas.	A6C6B486-E3A2-5D52-9E76-D9380485D946
Id	integer	El ID de la regla personalizada.	123123

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.