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

Actualiza una regla de alerta personalizada.

Descripción de la operación

Requisitos previos: debe activar DataWorks Enterprise Edition o Ultimate Edition antes de llamar a esta operación. Si no se cumplen los requisitos de edición, la operación devuelve un error 403 Forbidden.Access.

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
RemindId	integer	Sí	El ID de la regla de alerta personalizada.	1234
RemindName	string	No	El nombre de la regla de alerta personalizada. El nombre no puede superar los 128 caracteres de longitud.	update_remindname
DndEnd	string	No	La hora de finalización del periodo de no molestar, antes de la cual no se envían alertas. Especifique la hora en formato hh:mm. Valores válidos para hh: [0,23]. Valores válidos para mm: [0,59].	08:00
RemindUnit	string	No	El tipo de objeto monitoreado. Valores válidos: NODE: nodo. BASELINE: línea base. PROJECT: espacio de trabajo. BIZPROCESS: flujo de trabajo. Valores válidos: BASELINE : Línea base. PROJECT : Espacio de trabajo. NODE : Nodo. BIZPROCESS : Flujo de trabajo.	NODE
NodeIds	string	No	Los ID de los nodos cuando el objeto monitoreado es un nodo. Una sola regla admite el monitoreo de hasta 50 nodos. Separe varios ID de nodos con comas (,). Este parámetro solo surte efecto cuando el parámetro RemindUnit se establece en NODE.	1,2,3
BaselineIds	string	No	Los ID de las líneas base cuando el objeto monitoreado es una línea base. Una sola regla admite el monitoreo de hasta 5 líneas base. Separe varios ID de líneas base con comas (,). Este parámetro solo surte efecto cuando el parámetro RemindUnit se establece en BASELINE.	1,2,3
ProjectId	integer	No	El ID del espacio de trabajo cuando el objeto monitoreado es un espacio de trabajo. Una sola regla admite el monitoreo de un solo espacio de trabajo. Este parámetro solo surte efecto cuando el parámetro RemindUnit se establece en PROJECT.	1234
BizProcessIds	string	No	Los ID de los flujos de trabajo cuando el objeto monitoreado es un flujo de trabajo. Una sola regla admite el monitoreo de hasta 5 flujos de trabajo. Separe varios ID de flujos de trabajo con comas (,). Este parámetro solo surte efecto cuando el parámetro RemindUnit se establece en BIZPROCESS.	1,2,3
RemindType	string	No	La condición que activa la regla de alerta. Valores válidos: FINISHED: el sistema envía una alerta cuando la tarea se ejecuta correctamente. El monitoreo comienza desde el momento en que la instancia empieza a ejecutarse. UNFINISHED: el sistema envía una alerta si la tarea sigue ejecutándose a la hora especificada. El monitoreo comienza desde el momento en que la instancia empieza a ejecutarse. ERROR: el sistema envía una alerta cuando se produce un error mientras la tarea se está ejecutando. El monitoreo comienza desde el momento en que la instancia empieza a ejecutarse. CYCLE_UNFINISHED: el sistema envía una alerta si la instancia sigue ejecutándose dentro del ciclo especificado. Este valor se utiliza normalmente para monitorear instancias que se ejecutan en un ciclo por hora. TIMEOUT: el sistema envía una alerta si la tarea sigue ejecutándose después de la duración de ejecución especificada. El monitoreo comienza desde el momento en que la instancia empieza a ejecutarse. Este valor se utiliza normalmente para monitorear la duración de ejecución de las instancias. Para obtener más información sobre las condiciones que activan las reglas de alerta, consulte Reglas de alerta personalizadas.	FINISHED
MaxAlertTimes	integer	No	El número máximo de alertas. Valores válidos: de 1 a 10. Valor predeterminado: 3.	3
AlertInterval	integer	No	El intervalo de alerta. Unidad: segundos. Valor mínimo: 1200. Valor predeterminado: 1800.	1800
Detail	string	No	Los detalles de la configuración de parámetros para las diferentes causas condicionales: Cuando RemindType (causa) se establece en FINISHED, la configuración actual del parámetro está vacía. Cuando RemindType (causa) se establece en UNFINISHED, el ejemplo de formato de configuración para los parámetros actuales es {"hour":23,"minu":59}. Valores válidos para hour: [0,47]. Valores válidos para minu: [0,59]. Cuando RemindType (causa) se establece en ERROR, la configuración actual del parámetro está vacía. Cuando RemindType (causa) se establece en CYCLE_UNFINISHED (epoch sin finalizar), el ejemplo de formato de configuración para los parámetros actuales es {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. La clave en la cadena de caracteres JSON es el número de epoch, con valores válidos de [1,288]. El valor es la hora sin finalizar correspondiente al epoch, en formato hh:mm. Valores válidos para hh: [0,47]. Valores válidos para mm: [0,59]. Cuando RemindType (causa) se establece en TIMEOUT, el ejemplo de formato de configuración para los parámetros actuales es 1800, en segundos. Esto significa que se activa una alerta si la instancia se ejecuta durante más de 30 minutos desde el inicio.	{"hour":23,"minu":59}
AlertUnit	string	No	Los destinatarios de la alerta. Valores válidos: OWNER (propietario de la tarea) y OTHER (usuarios especificados). Valores válidos: OTHER : Usuarios especificados. OWNER : Propietario de la tarea.	OWNER
AlertMethods	string	No	Los métodos de notificación. Valores válidos: MAIL: correo electrónico. SMS: mensaje de texto. PHONE: llamada telefónica. Este método solo es compatible con DataWorks Professional Edition y versiones superiores. DINGROBOTS: chatbot de DingTalk. Este método solo surte efecto después de configurar el parámetro RobotUrls. Webhooks: chatbot de WeCom o Lark. Este método solo surte efecto después de configurar el parámetro Webhooks. Separe varios métodos de notificación con comas (,).	SMS,MAIL
AlertTargets	string	No	Los detalles de la configuración de parámetros para los diferentes destinatarios de alertas: Cuando AlertUnit (destinatario de la alerta) se establece en OWNER (propietario de la tarea), la configuración actual del parámetro está vacía. Cuando AlertUnit (destinatario de la alerta) se establece en OTHER (usuarios especificados), la configuración actual del parámetro son los UID de Alibaba Cloud de los usuarios especificados. Separe varios UID de Alibaba Cloud con comas (,). Puede especificar hasta 10 usuarios para recibir alertas.	9527952795279527
UseFlag	boolean	No	Especifica si se debe habilitar la regla de alerta. Valores válidos: true: habilita la regla de alerta. false: deshabilita la regla de alerta.	true
RobotUrls	string	No	Las URL de webhook del chatbot de grupo de DingTalk. Separe varias URL de webhook con comas (,). Cuando la configuración del parámetro se establece en undefined, el sistema borra las URL de webhook del chatbot de DingTalk.	https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooks	string	No	Las URL de webhook del chatbot de WeCom o Lark. Separe varias URL de webhook con comas (,). El parámetro alertMethods debe incluir el método de alerta WEBHOOKS. Cuando la configuración del parámetro se establece en undefined, el sistema borra las URL de webhook. Solo es compatible con DataWorks Enterprise Edition. Regiones disponibles: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt) y Asia-Pacific Southeast 1 (Singapore).	https://open.feishu.cn/open-apis/bot/v2/hook/*******

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
HttpStatusCode	integer	El código de estado HTTP.	200
Data	boolean	El resultado de actualizar la regla de alerta personalizada.	true
ErrorMessage	string	El mensaje de error.	The specified parameters are invalid.
RequestId	string	El ID único de la solicitud. Puede utilizar el ID para solucionar problemas si se produce un error.	0000-ABCD-EFG****
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: la solicitud se realiza correctamente. false: la solicitud falla.	true
ErrorCode	string	El código de error.	1031203110005

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "ErrorCode": "1031203110005"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	Forbidden.Wkbench.BaselineNoPermission	You are not authorized to access the baseline.
500	Forbidden.Wkbench.ProjectNoPermission	You are not authorized to access the workspace.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	Forbidden.Wkbench.RemindNoPermission	You are not authorized to modify the reminder.
500	Invalid.Wkbench.RemindNotExist	The reminder does not exist.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.Resource	You have reached the limit for the resource. Please contact us by submitting a ticket.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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.