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

Atualiza um fluxo de trabalho especificado usando o método de atualização completa. Os campos que podem ser atualizados sincronamente para o Data Studio incluem: proprietário, fonte de dados, grupo de recursos de agendamento, descrição e modo de execução do gatilho (Normal, Skip ou Pause).

Descrição da operação

É necessário o DataWorks Basic Edition ou uma edição mais avançada.

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
Id	integer	Sim	O ID do fluxo de trabalho.	1234
EnvType	string	Não	O ambiente do projeto. Valores válidos: Prod: produção Dev: desenvolvimento	Prod
Name	string	Sim	O nome.	My Workflow
Owner	string	Sim	O ID da conta do proprietário.	1000
Trigger	object	Sim	A configuração do gatilho.
Type	string	Sim	O tipo de gatilho. Valores válidos: Scheduler: acionado por um ciclo de agendamento Manual: acionado manualmente	Scheduler
Cron	string	Não	A expressão cron. Este parâmetro entra em vigor apenas quando o tipo é definido como Scheduler.	00 00 00 * * ?
StartTime	string	Não	A hora em que o gatilho periódico entra em vigor. Este parâmetro entra em vigor apenas quando o tipo é definido como Scheduler. Formato: `yyyy-mm-dd hh:mm:ss`.	1970-01-01 00:00:00
EndTime	string	Não	A hora em que o gatilho periódico expira. Este parâmetro entra em vigor apenas quando o tipo é definido como Scheduler. Formato: `yyyy-mm-dd hh:mm:ss`.	9999-01-01 00:00:00
Description	string	Não	A descrição.	test
Dependencies	array<object>	Não	As informações de dependência.
	object	Não
Type	string	Sim	O tipo de dependência. Valores válidos: CrossCycleDependsOnChildren: dependência entre ciclos em nós filho de primeiro nível CrossCycleDependsOnSelf: dependência entre ciclos no nó atual CrossCycleDependsOnOtherNode: dependência entre ciclos em outros nós Normal: dependência no mesmo ciclo	Normal
UpstreamOutput	string	Não	O identificador de saída do nó upstream. Este campo é retornado quando o tipo de dependência é `dependência no mesmo ciclo` e o conteúdo de entrada é especificado.	pre.odps_sql_demo_0
UpstreamTaskId	integer	Não	O ID do nó upstream. Este campo é retornado quando o tipo de dependência é `dependência entre ciclos em outros nós` ou `dependência no mesmo ciclo` sem conteúdo de entrada especificado. Não é retornado em outros casos.	1234
Parameters	string	Não	A lista de parâmetros.	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	Não	A lista de nós.
	array<object>	Não
Id	integer	Não	O ID do nó. Se este campo for especificado, o nó correspondente será totalmente atualizado. Se este campo não for especificado, um novo nó será criado.	1234
Name	string	Sim	O nome do nó.	SQL node
Description	string	Não	A descrição.	Test
Type	string	Sim	O tipo de nó.	ODPS_SQL
Owner	string	Sim	O ID da conta do proprietário.	1000
BaseLineId	integer	Não	O ID da linha de base.	1234
Timeout	integer	Não	O período de tempo limite para a execução do nó, em segundos.	3600
RerunMode	string	Sim	Especifica se o nó pode ser reexecutado. Valores válidos: AllDenied: não pode ser reexecutado independentemente de sucesso ou falha FailureAllowed: pode ser reexecutado apenas em caso de falha AllAllowed: pode ser reexecutado independentemente de sucesso ou falha	AllAllowed
RerunTimes	integer	Não	O número de novas tentativas. Este parâmetro entra em vigor apenas quando o nó está configurado para permitir reexecuções.	3
RerunInterval	integer	Não	O intervalo de tempo de nova tentativa, em segundos.	60
Script	object	Não	As informações do script.
Content	string	Não	O conteúdo do script.	echo "helloWorld"
Parameters	string	Não	A lista de parâmetros do script.	para1=$bizdate
Trigger	object	Sim	A configuração de gatilho do nó.
Type	string	Não	O tipo de gatilho. Valores válidos: Scheduler: acionado por um ciclo de agendamento Manual: acionado manualmente	Scheduler
Recurrence	string	Sim	O modo de execução quando acionado. Este parâmetro entra em vigor apenas quando o tipo é definido como Scheduler. Valores válidos: Pause: pausado Skip: dry run Normal: execução normal	Normal
RuntimeResource	object	Sim	A configuração do ambiente de execução, como informações do grupo de recursos.
ResourceGroupId	string	Sim	O identificador do grupo de recursos de agendamento configurado para o nó.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	Não	O ID da imagem configurado para o nó.	i-xxxxxx
Cu	string	Não	O consumo de CU configurado para o nó.	0.25
DataSource	object	Não	As informações da fonte de dados associada.
Name	string	Não	O nome da fonte de dados.	odps_test
Inputs	object	Não	As informações de entrada. Se este campo estiver vazio, todas as configurações de Inputs serão excluídas por padrão.
Variables	array<object>	Não	A lista de definições de variáveis. Se este campo não for especificado ou for uma matriz vazia, todas as configurações de Inputs.Variables serão excluídas por padrão.
	object	Não
Name	string	Não	O nome da variável.	key1
Type	string	Sim	O tipo. Valores válidos: Constant: constante PassThrough: saída de um nó de parâmetro System: variável NodeOutput: saída de script	Constant
Value	string	Não	O valor da variável.	value1
Outputs	object	Não	As informações de saída. Se este campo estiver vazio, todas as configurações de Outputs serão excluídas por padrão.
TaskOutputs	array<object>	Não	A lista de definições de saída do nó. Se este campo não for especificado ou for uma matriz vazia, todas as configurações de TaskOutputs serão excluídas por padrão.
	object	Não
Output	string	Não	O identificador de saída.	pre.odps_sql_demo_0
Variables	array<object>	Não	A lista de definições de variáveis. Se este campo não for especificado ou for uma matriz vazia, todas as configurações de Outputs.Variables serão excluídas por padrão.
	object	Não
Name	string	Não	O nome da variável.	key1
Type	string	Sim	O tipo. Valores válidos: Constant: constante PassThrough: saída de um nó de parâmetro System: variável NodeOutput: saída de script	Constant
Value	string	Não	O valor da variável.	value1
Dependencies	array<object>	Não	As informações de dependência. Se este campo não for especificado ou for uma matriz vazia, todas as configurações de Dependencies serão excluídas por padrão.
	object	Não
Type	string	Sim	O tipo de dependência. Valores válidos: CrossCycleDependsOnChildren: dependência entre ciclos em nós filho de primeiro nível CrossCycleDependsOnSelf: dependência entre ciclos no nó atual CrossCycleDependsOnOtherNode: dependência entre ciclos em outros nós Normal: dependência no mesmo ciclo	Normal
UpstreamOutput	string	Não	O identificador de saída do nó upstream. Este campo é retornado quando o tipo de dependência é `dependência no mesmo ciclo` e o conteúdo de entrada é especificado.	pre.odps_sql_demo_0
UpstreamTaskId	integer	Não	O ID do nó upstream. Este campo é retornado quando o tipo de dependência é `dependência entre ciclos em outros nós` ou `dependência no mesmo ciclo` sem conteúdo de entrada especificado. Não é retornado em outros casos.	1234
Tags	array<object>	Não	A lista de tags do nó. Se este campo não for especificado ou for uma matriz vazia, todas as configurações de Tags serão excluídas por padrão.
	object	Não
Key	string	Sim	A chave da tag.	key1
Value	string	Não	O valor da tag.	value1
ClientUniqueCode	string	Não	O código exclusivo do cliente do nó, usado para operações assíncronas e idempotência. Se não for especificado durante a criação, o sistema gera um automaticamente, e o código é vinculado exclusivamente ao ID do recurso. Se este parâmetro for especificado durante a atualização ou exclusão, ele deve ser consistente com o código exclusivo do cliente usado durante a criação.	Task_0bc5213917368545132902xxxxxxxx
EnvType	string	Não	O ambiente do projeto. Valores válidos: Prod: produção Dev: desenvolvimento	Prod
Outputs	object	Não	As informações de saída.
TaskOutputs	array<object>	Não	A lista de definições de saída do nó do fluxo de trabalho.
	object	Não
Output	string	Não	O identificador de saída.	pre.odps_sql_demo_0
Tags	array<object>	Não	A lista de tags do fluxo de trabalho.
	object	Não
Key	string	Sim	A chave da tag.	key1
Value	string	Não	O valor da tag.	value1
ClientUniqueCode	string	Não	O código exclusivo do cliente do fluxo de trabalho, usado para operações assíncronas e idempotência. Se não for especificado durante a criação, o sistema gera um automaticamente, e o código é vinculado exclusivamente ao ID do recurso. Se este parâmetro for especificado durante a atualização ou exclusão, ele deve ser consistente com o código exclusivo do cliente usado durante a criação.	Workflow_0bc5213917368545132902xxxxxxxx
InstanceMode	string	Não	O modo de geração de instâncias. Valores válidos: T+1: As instâncias são geradas no dia seguinte. Immediately: As instâncias são geradas imediatamente. As instâncias periódicas são geradas apenas se o horário agendado do fluxo de trabalho for pelo menos 10 minutos após a implantação do fluxo de trabalho. Durante o período de geração completa de instâncias (22:00 às 24:00), a geração de instâncias em tempo real não está disponível. Você pode enviar e implantar fluxos de trabalho durante este período, mas as instâncias não são regeneradas após o envio. Valores válidos: Immediately : 立即生成 T+1 : 第二天生成	T+1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação, que é usado para localizar logs e solucionar problemas.	22C97E95-F023-56B5-8852-B1A77A17XXXX
Success	boolean	Indica se a operação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Success": true
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.