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

Cria uma regra de alerta personalizada chamando CreateRemind.

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
RemindName	string	Sim	O nome da regra personalizada. O nome pode ter até 128 caracteres.	test_error_remind
DndEnd	string	Não	A hora de término do período de não perturbe, no formato hh:mm. Valores válidos de hh: [0,23]. Valores válidos de mm: [0,59].	08:00
RemindUnit	string	Sim	O tipo do objeto. Valores válidos: NODE (nó), BASELINE (linha de base), PROJECT (workspace) e BIZPROCESS (processo de negócios). Valores válidos: BASELINE : linha de base. PROJECT : workspace. NODE : nó. BIZPROCESS : processo de negócios.	NODE
NodeIds	string	Não	Os IDs dos nós a serem monitorados quando RemindUnit (tipo de objeto) estiver definido como NODE (nó). Separe vários IDs com vírgulas (,). No máximo 50 nós podem ser monitorados por uma única regra.	1,2,3
BaselineIds	string	Não	Os IDs das linhas de base a serem monitoradas quando RemindUnit (tipo de objeto) estiver definido como BASELINE (linha de base). Separe vários IDs com vírgulas (,). No máximo 5 linhas de base podem ser monitoradas por uma única regra.	1,2,3
ProjectId	integer	Não	O ID do workspace a ser monitorado quando RemindUnit (tipo de objeto) estiver definido como PROJECT (workspace). Uma única regra pode monitorar apenas um workspace.	9527
BizProcessIds	string	Não	Os IDs dos processos de negócios a serem monitorados quando RemindUnit (tipo de objeto) estiver definido como BIZPROCESS (processo de negócios). Separe vários IDs de processos de negócios com vírgulas (,). No máximo 5 processos de negócios podem ser monitorados por uma única regra.	1,2,3
RemindType	string	Sim	A condição de acionamento. Valores válidos: FINISHED (concluído), UNFINISHED (não concluído), ERROR (erro), CYCLE_UNFINISHED (ciclo não concluído) e TIMEOUT (tempo limite de execução).	FINISHED
MaxAlertTimes	integer	Não	O número máximo de alertas. Valor mínimo: 1. Valor máximo: 10. Valor padrão: 3.	2
AlertInterval	integer	Não	O intervalo mínimo de alerta, em segundos. Valor mínimo: 1200. Valor padrão: 1800.	1800
Detail	string	Não	As descrições para diferentes condições de acionamento são as seguintes: Quando RemindType (condição de acionamento) estiver definido como FINISHED (concluído), passe um valor vazio. Quando RemindType (condição de acionamento) estiver definido como UNFINISHED (não concluído), passe o parâmetro no formato {"hour":23,"minu":59}. Valores válidos de hour: [0,47]. Valores válidos de minu: [0,59]. Quando RemindType (condição de acionamento) estiver definido como ERROR (erro), passe um valor vazio. Quando RemindType (condição de acionamento) estiver definido como CYCLE_UNFINISHED (ciclo não concluído), passe o 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 de caracteres JSON é o número do ciclo. Valores válidos: [1,288]. O valor é a hora de não conclusão para o ciclo correspondente, no formato hh:mm. Valores válidos de hh: [0,47]. Valores válidos de mm: [0,59]. Quando RemindType (condição de acionamento) estiver definido como TIMEOUT (tempo limite de execução), passe o parâmetro como um valor como 1800, em segundos. Isso significa que um alerta será acionado se o tempo de execução exceder 30 minutos desde o início da execução.	{"hour":"23","minu":"59"}
AlertUnit	string	Sim	A granularidade do destinatário do alerta. Valores válidos: OWNER (proprietário do nó) e OTHER (usuário especificado). Valores válidos: OTHER : usuário especificado. OWNER : proprietário do nó.	OWNER
AlertMethods	string	Sim	O método de alerta. Valores válidos: MAIL: e-mail. SMS: mensagem de texto. As regiões que suportam alertas por SMS são Singapura, Malásia (Kuala Lumpur) e Alemanha (Frankfurt). Webhooks (chatbot WeCom ou Lark). Este método de alerta entra em vigor somente após a configuração do parâmetro Webhooks. DINGROBOTS: chatbot DingTalk. Separe vários métodos de alerta com vírgulas (,).	SMS,MAIL
AlertTargets	string	Não	Quando AlertUnit (destinatário do alerta) estiver definido como OWNER (proprietário do nó), passe um valor vazio. Quando AlertUnit (destinatário do alerta) estiver definido como OTHER (usuário especificado), passe os UIDs da Alibaba Cloud dos usuários especificados. Separe vários UIDs da Alibaba Cloud com vírgulas (,). No máximo 10 UIDs são suportados.	9527952795279527
RobotUrls	string	Não	As URLs de webhook dos chatbots DingTalk. Separe várias URLs de webhook com vírgulas (,).	https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooks	string	Não	As URLs de webhook dos chatbots WeCom ou Lark. Separe várias URLs de webhook com vírgulas (,). O parâmetro alertMethods deve incluir o método de alerta WEBHOOKS. Apenas o DataWorks Enterprise Edition é suportado. Regiões disponíveis: China (Xangai), China (Chengdu), China (Zhangjiakou), China (Pequim), China (Hangzhou), China (Shenzhen), Hong Kong (China), Alemanha (Frankfurt) e Singapura.	https://open.feishu.cn/open-apis/bot/v2/hook/*******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
Data	integer	O ID da regra personalizada retornado após a criação da regra de monitoramento personalizada.	1234
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid
RequestId	string	O ID exclusivo da solicitação. Você pode usar este ID para solucionar problemas.	0000-ABCD-EFG****
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrorCode	string	O código de erro.	1031203110005

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "Data": 1234,
  "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	Descrição
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.NoProject	You have not joined any project.
500	Invalid.Wkbench.NodeNotExist	The node does not exist.
500	Invalid.Wkbench.BaselineNotExist	The baseline does not exist.
500	Forbidden.Wkbench.RemindOverlimit	The maximum number of reminders is exceeded.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Autorize o acesso.
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.