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

Atualiza uma regra de monitoramento personalizada.

Descrição da operação

Suportado no DataWorks Basic Edition ou em uma edição superior.

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
RemindId	integer	Sim	O ID da regra personalizada.	1234
RemindName	string	Não	O nome da regra personalizada. O nome não pode exceder 128 caracteres de comprimento.	update_remindname
DndEnd	string	Não	A hora de término do período de não perturbe, antes da qual nenhum alerta é enviado. Especifique a hora no formato hh:mm. Valores válidos para hh: [0,23]. Valores válidos para mm: [0,59].	08:00
RemindUnit	string	Não	O tipo do objeto monitorado. Valores válidos: NODE: nó BASELINE: linha de base PROJECT: espaço de trabalho BIZPROCESS: fluxo de trabalho Valores válidos: BASELINE : Linha de base. PROJECT : Espaço de trabalho. NODE : Nó. BIZPROCESS : Fluxo de trabalho.	NODE
NodeIds	string	Não	Os IDs dos nós quando o objeto monitorado é um nó. Uma única regra de monitoramento pode monitorar até 50 nós. Separe vários IDs de nós com vírgulas (,). Este parâmetro entra em vigor somente quando o parâmetro RemindUnit é definido como NODE.	1,2,3
BaselineIds	string	Não	Os IDs das linhas de base quando o objeto monitorado é uma linha de base. Uma única regra de monitoramento pode monitorar até 5 linhas de base. Separe vários IDs de linhas de base com vírgulas (,). Este parâmetro entra em vigor somente quando o parâmetro RemindUnit é definido como BASELINE.	1,2,3
ProjectId	integer	Não	O ID do espaço de trabalho quando o objeto monitorado é um espaço de trabalho. Uma única regra de monitoramento pode monitorar apenas um espaço de trabalho. Este parâmetro entra em vigor somente quando o parâmetro RemindUnit é definido como PROJECT.	1234
BizProcessIds	string	Não	Os IDs dos fluxos de trabalho quando o objeto monitorado é um fluxo de trabalho. Uma única regra de monitoramento pode monitorar até 5 fluxos de trabalho. Separe vários IDs de fluxos de trabalho com vírgulas (,). Este parâmetro entra em vigor somente quando o parâmetro RemindUnit é definido como BIZPROCESS.	1,2,3
RemindType	string	Não	A condição que aciona a regra de alerta. Valores válidos: FINISHED: O sistema envia um alerta quando a tarefa é executada com sucesso. O monitoramento começa a partir do momento em que a instância começa a ser executada. UNFINISHED: O sistema envia um alerta se a tarefa ainda estiver em execução no horário especificado. O monitoramento começa a partir do momento em que a instância começa a ser executada. ERROR: O sistema envia um alerta quando ocorre um erro durante a execução da tarefa. O monitoramento começa a partir do momento em que a instância começa a ser executada. CYCLE_UNFINISHED: O sistema envia um alerta se a instância ainda estiver em execução dentro do ciclo especificado. Este valor é normalmente usado para monitorar instâncias que são executadas em um ciclo de hora em hora. TIMEOUT: O sistema envia um alerta se a tarefa ainda estiver em execução após a duração de execução especificada. O monitoramento começa a partir do momento em que a instância começa a ser executada. Este valor é normalmente usado para monitorar a duração de execução das instâncias. Para obter mais informações sobre as condições que acionam as regras de alerta, consulte Regras personalizadas. Valores válidos: FINISHED UNFINISHED ERROR CYCLE_UNFINISHED TIMEOUT EXHAUSTED_ERROR	FINISHED
MaxAlertTimes	integer	Não	O número máximo de alertas. Valores válidos: [1,10]. Valor padrão: 3.	3
AlertInterval	integer	Não	O intervalo de alerta. Unidade: segundos. Valor mínimo: 1200. Valor padrão: 1800.	1800
Detail	string	Não	As configurações de parâmetro para diferentes condições de acionamento: Se o RemindType (condição de acionamento) estiver definido como FINISHED, deixe as configurações de parâmetro vazias. Se o RemindType (condição de acionamento) estiver definido como UNFINISHED, especifique as configurações de parâmetro no formato {"hour":23,"minu":59}. Valores válidos para hour: [0,47]. Valores válidos para minu: [0,59]. Se o RemindType (condição de acionamento) estiver definido como ERROR, deixe as configurações de parâmetro vazias. Se o RemindType (condição de acionamento) estiver definido como CYCLE_UNFINISHED (ciclo não concluído), especifique as configurações de parâmetro no formato {"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"}. A chave na string JSON é o número do ciclo, e os valores válidos são [1,288]. O valor é o horário não concluído para o ciclo, no formato hh:mm. Valores válidos para hh: [0,47]. Valores válidos para mm: [0,59]. Se o RemindType (condição de acionamento) estiver definido como TIMEOUT, especifique as configurações de parâmetro em segundos. Exemplo: 1800. Isso significa que um alerta é acionado se a instância for executada por mais de 30 minutos após o início.	{"hour":23,"minu":59}
AlertUnit	string	Não	Os destinatários do alerta. Valores válidos: OWNER (proprietário da tarefa) e OTHER (usuários especificados). Valores válidos: OTHER : Usuários especificados. OWNER : Proprietário da tarefa.	OWNER
AlertMethods	string	Não	Os métodos de alerta. Valores válidos: MAIL: e-mail. SMS: mensagem de texto. PHONE: chamada telefônica. Este método é suportado apenas no DataWorks Professional Edition ou em uma edição superior. DINGROBOTS: chatbot do DingTalk. Este método entra em vigor somente após a configuração do parâmetro RobotUrls. Webhooks: chatbot do WeCom ou Lark. Este método entra em vigor somente após a configuração do parâmetro Webhooks. Separe vários métodos de alerta com vírgulas (,).	SMS,MAIL
AlertTargets	string	Não	As configurações de parâmetro para diferentes destinatários de alerta: Se o AlertUnit estiver definido como OWNER (proprietário da tarefa do nó), deixe este parâmetro vazio. Se o AlertUnit estiver definido como OTHER (usuários especificados), especifique seus UIDs do Alibaba Cloud. Separe vários UIDs com vírgulas (,). Você pode especificar até 10 usuários para receber alertas.	9527952795279527
UseFlag	boolean	Não	Especifica se a regra de alerta deve ser ativada. Valores válidos: true: A regra de alerta está ativada. false: A regra de alerta está desativada.	true
RobotUrls	string	Não	As URLs de webhook do chatbot de grupo do DingTalk. Separe várias URLs de webhook com vírgulas (,). Se as configurações do parâmetro estiverem definidas como undefined, o sistema limpa as URLs de webhook do chatbot do DingTalk.	https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooks	string	Não	As URLs de webhook do chatbot do WeCom ou Lark. Separe várias URLs de webhook com vírgulas (,). O parâmetro AlertMethods deve incluir o método de alerta WEBHOOKS. Se as configurações do parâmetro estiverem definidas como undefined, o sistema limpa as URLs de webhook. Este parâmetro é suportado apenas no DataWorks Enterprise Edition. Regiões disponíveis: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Alemanha (Frankfurt) e Singapura.	https://open.feishu.cn/open-apis/bot/v2/hook/*******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
HttpStatusCode	integer	O código de status HTTP.	200
Data	boolean	O resultado da atualização da regra de monitoramento personalizada.	true
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid.
RequestId	string	O ID exclusivo da solicitação. Você pode usar o ID para solucionar problemas quando ocorrer um erro.	0000-ABCD-EFG****
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
ErrorCode	string	O código de erro.	1031203110005

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.