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

Cria uma regra de alerta personalizada.

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 de alerta personalizada. O nome não pode ter mais de 128 caracteres.	test_error_remind
DndEnd	string	Não	A hora de término do período de silêncio. 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	Sim	O tipo de objeto ao qual a regra de alerta personalizada se aplica. Valores válidos: NODE, BASELINE, PROJECT e BIZPROCESS. O valor NODE indica um nó. O valor BASELINE indica uma linha de base. O valor PROJECT indica um workspace. O valor BIZPROCESS indica um fluxo de trabalho.	NODE
NodeIds	string	Não	O ID do nó ao qual a regra de alerta personalizada se aplica. Este parâmetro tem efeito quando o parâmetro RemindUnit é definido como NODE. Você pode especificar vários IDs. Separe vários IDs com vírgulas (,). No máximo 50 nós podem ser especificados para uma regra de alerta personalizada.	1,2,3
BaselineIds	string	Não	O ID da linha de base à qual a regra de alerta personalizada se aplica. Este parâmetro tem efeito quando o parâmetro RemindUnit é definido como BASELINE. Você pode especificar vários IDs. Separe vários IDs com vírgulas (,). No máximo cinco linhas de base podem ser especificadas para uma regra de alerta personalizada.	1,2,3
ProjectId	integer	Não	O ID do workspace ao qual a regra de alerta personalizada se aplica. Este parâmetro tem efeito quando o parâmetro RemindUnit é definido como PROJECT. Você pode especificar apenas um workspace para uma regra de alerta personalizada.	9527
BizProcessIds	string	Não	O ID do fluxo de trabalho ao qual a regra de alerta personalizada se aplica. Este parâmetro tem efeito quando o parâmetro RemindUnit é definido como BIZPROCESS. Você pode especificar vários IDs. Separe vários IDs com vírgulas (,). No máximo cinco fluxos de trabalho podem ser especificados para uma regra de alerta personalizada.	1,2,3
RemindType	string	Sim	As condições que acionam um alerta. Valores válidos: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED e TIMEOUT.	FINISHED
MaxAlertTimes	integer	Não	O número máximo de alertas. Valores válidos: 1 a 10. Valor padrão: 3.	2
AlertInterval	integer	Não	O intervalo mínimo no qual os alertas são reportados. Unidade: segundos. Valor mínimo: 1200. Valor padrão: 1800.	1800
Detail	string	Não	Os detalhes das condições que acionam um alerta. Se o parâmetro RemindType for definido como FINISHED, deixe este parâmetro vazio. Se o parâmetro RemindType for definido como UNFINISHED, configure este parâmetro como pares chave-valor. Exemplo: {"hour":23,"minu":59}. Valores válidos para hour: [0,47]. Valores válidos para minu: [0,59]. Se o parâmetro RemindType for definido como ERROR, deixe este parâmetro vazio. Se o parâmetro RemindType for definido como CYCLE_UNFINISHED, configure este parâmetro como pares chave-valor. Exemplo: {"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 indica o ID do ciclo. Valores válidos: [1,288]. O valor indica o período de tempo limite do nó que está em execução no ciclo. Especifique o valor no formato hh:mm. Valores válidos para hh: [0,47]. Valores válidos para mm: [0,59]. Se o parâmetro RemindType for definido como TIMEOUT, defina este parâmetro como o período de tempo limite. Unidade: segundos. Exemplo: 1800. Este valor indica que um alerta é reportado se o nó for executado por mais de 30 minutos.	{"hour":"23","minu":"59"}
AlertUnit	string	Sim	O destinatário do alerta. Valores válidos: OWNER e OTHER. O valor OWNER indica o proprietário do nó. O valor OTHER indica um usuário especificado.	OWNER
AlertMethods	string	Sim	O método de notificação. Valores válidos: MAIL: As notificações de alerta são enviadas por e-mail. SMS: As notificações de alerta são enviadas por mensagem de texto. As notificações de alerta podem ser enviadas por mensagem de texto apenas nas regiões de Singapura, Malásia (Kuala Lumpur) e Alemanha (Frankfurt). WEBHOOKS (chatbot do WeCom ou Lark): As notificações de alerta são enviadas por mensagem do WeCom ou Lark. Se você quiser usar este método de notificação, deverá configurar o parâmetro Webhooks. DINGROBOTS: As notificações de alerta são enviadas pelo chatbot do DingTalk. Você pode especificar vários métodos de notificação. Separe-os com vírgulas (,).	SMS,MAIL
AlertTargets	string	Não	Se o parâmetro AlertUnit for definido como OWNER, deixe este parâmetro vazio. Se o parâmetro AlertUnit for definido como OTHER, defina este parâmetro como o ID da conta da Alibaba Cloud usada pelo usuário especificado. Você pode especificar vários IDs. Separe vários IDs com vírgulas (,). Você pode especificar no máximo 10 IDs.	9527952795279527
RobotUrls	string	Não	A URL do webhook do chatbot do DingTalk. Você pode especificar várias URLs de webhook. Separe várias URLs de webhook com vírgulas (,).	https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooks	string	Não	A URL do webhook do chatbot do WeCom ou Lark. Você pode especificar várias URLs de webhook. Separe várias URLs de webhook com vírgulas (,). Você deve especificar WEBHOOKS para AlertMethods. Apenas o DataWorks Enterprise Edition oferece suporte a este parâmetro. O recurso de alerta baseado em URL de webhook é compatível com as seguintes regiões: 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	Os parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
Data	integer	O ID da regra de alerta personalizada.	1234
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid.
RequestId	string	O ID da solicitação.	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.	No permission, please authorize
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.