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

Atualiza um arquivo existente.

Descrição da operação

Ao depurar ou chamar esta operação, os parâmetros especificados devem ser diferentes das configurações originais do arquivo do nó. Por exemplo, se o valor de um parâmetro para o nó de origem for A, você deverá alterar o valor para B antes de enviar a solicitação. Se você ainda especificar A, uma exceção inválida será relatada.

Esta operação é compatível com o DataWorks Basic Edition ou 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
FileFolderPath	string	Não	O caminho do arquivo.	Business_process/First_Business_Process/data_integration/Folder_1/Folder_2
ProjectId	integer	Não	O ID do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página de gerenciamento de workspaces para obter o ID.	100001
FileName	string	Não	O nome do arquivo. Você pode alterar o nome do arquivo redefinindo o valor de FileName. Por exemplo, você pode chamar a operação ListFiles para consultar o ID de um arquivo no diretório de destino e, em seguida, chamar a operação UpdateFile. Defina o parâmetro FileId como o ID do arquivo consultado e especifique o parâmetro FileName para alterar o nome do arquivo.	ods_user_info_d
FileDescription	string	Não	A descrição do arquivo.	Here is the file description
Content	string	Não	O conteúdo do código do arquivo. O formato do código varia de acordo com o tipo de arquivo. Você pode acessar o Operation Center, clicar com o botão direito do mouse em uma tarefa do tipo correspondente e selecionar View Code para visualizar o formato específico do código.	SELECT "1";
AutoRerunTimes	integer	Não	O número de novas execuções automáticas após a ocorrência de um erro.	3
AutoRerunIntervalMillis	integer	Não	O intervalo para novas execuções automáticas após a ocorrência de um erro. Unidade: milissegundos. Valor máximo: 1800000, que equivale a 30 minutos. Este parâmetro corresponde ao parâmetro Rerun Interval na seção Schedule Settings > Time Attributes > Automatic Rerun after Error do console do DataWorks. A unidade do parâmetro Rerun Interval no console é minutos. Converta a unidade de tempo ao chamar esta operação. console do DataWorks	120000
RerunMode	string	Não	O modo de nova execução. Valores válidos: ALL_ALLOWED: O nó pode ser executado novamente independentemente de ser executado com sucesso ou falhar. FAILURE_ALLOWED: O nó não pode ser executado novamente se for executado com sucesso, mas pode ser executado novamente se falhar. ALL_DENIED: O nó não pode ser executado novamente independentemente de ser executado com sucesso ou falhar. Este parâmetro corresponde ao parâmetro Rerun Mode na seção Schedule Settings > Time Attributes > Rerun Mode do console do DataWorks. console do DataWorks Valores válidos: ALL_ALLOWED : O nó pode ser executado novamente independentemente de ser executado com sucesso ou falhar. ALL_DENIED : O nó não pode ser executado novamente independentemente de ser executado com sucesso ou falhar. ALL_ALLOWD : O nó pode ser executado novamente independentemente de ser executado com sucesso ou falhar. FAILURE_ALLOWED : O nó pode ser executado novamente apenas se falhar.	ALL_ALLOWED
Stop	boolean	Não	Especifica se o agendamento deve ser pausado. Valores válidos: true: Pausa o agendamento. false: Não pausa o agendamento. Este parâmetro corresponde à opção Pause Scheduling na seção Schedule Settings > Time Attributes > Schedule Type do console do DataWorks. console do DataWorks	false
ParaValue	string	Não	Os parâmetros de agendamento. Este parâmetro corresponde à seção Parameters na seção Schedule Settings > Parameters do console do DataWorks. Para mais informações, consulte Parâmetros de agendamento. console do DataWorks	x=a y=b z=c
StartEffectDate	integer	Não	O carimbo de data/hora em milissegundos em que o agendamento automático é iniciado. Este parâmetro corresponde à hora de início do parâmetro Effective Date na seção Schedule Settings > Time Attributes > Effective Date do console do DataWorks. console do DataWorks	936923400000
EndEffectDate	integer	Não	O carimbo de data/hora em milissegundos em que o agendamento automático é interrompido. Este parâmetro corresponde à hora de término do parâmetro Effective Date na seção Schedule Settings > Time Attributes > Effective Date do console do DataWorks. console do DataWorks	4155787800000
CronExpress	string	Não	A expressão cron para agendamento periódico. Este parâmetro corresponde ao parâmetro Cron Expression na seção Schedule > Time Property > Cron Expression do console do DataWorks. Após configurar o ciclo de agendamento e o horário agendado, o DataWorks gera automaticamente a expressão cron correspondente. Exemplos: Agendar um nó às 05:30 todos os dias: `00 30 05 * * ?`. Agendar um nó no 15º minuto de cada hora: `00 15 * * * ?`. Agendar um nó a cada 10 minutos: `00 00/10 * * * ?`. Agendar um nó a cada 10 minutos das 08:00 às 17:00 todos os dias: `00 00-59/10 8-23 * * * ?`. Agendar um nó às 00:20 no primeiro dia de cada mês: `00 20 00 1 * ?`. Agendar um nó a cada três meses a partir das 00:10 de 1º de janeiro: `00 10 00 1 1-12/3 ?`. Agendar um nó às 00:05 toda terça e sexta-feira: `00 05 00 * * 2,5`. Devido às regras do sistema de agendamento do DataWorks, as expressões cron têm os seguintes limites: O intervalo mínimo de agendamento é de 5 minutos. O horário de agendamento mais cedo de um dia é 00:05.	00 00-59/5 1-23 * * ?
CycleType	string	Não	O tipo do ciclo de agendamento. Valores válidos: NOT_DAY (minuto e hora) e DAY (dia, semana e mês). Este parâmetro corresponde ao parâmetro Scheduling Cycle na seção Schedule Settings > Time Attributes > Scheduling Cycle do console do DataWorks. console do DataWorks Valores válidos: NOT_DAY : Agendamento por minuto ou hora. DAY : Agendamento por dia, semana ou mês.	NOT_DAY
DependentType	string	Não	A dependência do ciclo anterior. Valores válidos: SELF: O nó depende de si mesmo. CHILD: O nó depende de seus nós filhos de nível 1. USER_DEFINE: O nó depende de outros nós. NONE: O nó não depende do ciclo anterior. Valores válidos: CHILD_AND_SELF : Depende dos nós filhos de nível 1 e do nó atual. USER_DEFINE : Depende de outros nós. SELF : Depende do nó atual. USER_DEFINE_AND_SELF : Depende de outros nós e do nó atual. NONE : Não depende do ciclo anterior. CHILD : Depende dos nós filhos de nível 1.	USER_DEFINE
DependentNodeIdList	string	Não	Os IDs dos nós dos quais o arquivo atual depende. Este parâmetro é usado para especificar os IDs dos nós dependentes quando o parâmetro DependentType é definido como USER_DEFINE. Separe vários IDs de nós com vírgulas (,). Este parâmetro corresponde ao conteúdo configurado quando o parâmetro Schedule Settings > Scheduling Dependencies é definido como Previous Cycle e o item dependente é definido como Other Nodes para um nó de desenvolvimento de dados no console do DataWorks.	5,10,15,20
InputList	string	Não	Os nomes de saída dos arquivos upstream dos quais o arquivo atual depende. Separe vários nomes de saída com vírgulas (,). Este parâmetro corresponde ao parâmetro Parent Node Output Name na seção Schedule Settings > Scheduling Dependencies > Same Cycle do console do DataWorks. Nota Este parâmetro é obrigatório quando você cria uma tarefa de sincronização em lote chamando as operações CreateDISyncTask e UpdateFile. console do DataWorks	project_root,project.file1,project.001_out
ProjectIdentifier	string	Não	O nome do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Workspace Configuration para obter o nome do workspace. Você deve especificar este parâmetro ou o parâmetro ProjectId para determinar o workspace do DataWorks para esta chamada de API.	dw_project
FileId	integer	Sim	O ID do arquivo. Você pode chamar a operação ListFiles para obter o ID do arquivo.	100000001
OutputList	string	Não	A saída do arquivo. Este parâmetro corresponde ao parâmetro Output Name of Current Node na seção Schedule Settings > Scheduling Dependencies > Same Cycle do console do DataWorks. console do DataWorks	dw_project.ods_user_info_d
ResourceGroupIdentifier	string	Não	O grupo de recursos usado para executar a tarefa após o arquivo ser implantado como uma tarefa. Você pode chamar a operação ListResourceGroups para obter a lista de grupos de recursos disponíveis no workspace.	default_group
ConnectionName	string	Não	O identificador da fonte de dados usada pela tarefa quando a tarefa correspondente ao arquivo é executada. Você pode chamar a operação ListDataSources para obter a lista de fontes de dados disponíveis.	odps_source
Owner	string	Não	O ID de usuário do proprietário do arquivo.	18023848927592
AutoParsing	boolean	Não	Especifica se o recurso de análise automática deve ser ativado para o arquivo. Valores válidos: true: O arquivo analisa o código automaticamente. false: O arquivo não analisa o código automaticamente. Este parâmetro corresponde à opção Code Parsing na seção Schedule Settings > Scheduling Dependencies > Same Cycle do console do DataWorks. console do DataWorks	true
SchedulerType	string	Não	O tipo de agendamento. Valores válidos: NORMAL: Tarefa de agendamento normal. MANUAL: Tarefa manual. A tarefa não é executada em um agendamento diário e corresponde a um nó em um workflow manual. PAUSE: Tarefa pausada. SKIP: Tarefa de dry-run. A tarefa é executada em um agendamento diário, mas seu status é definido diretamente como bem-sucedido quando o agendamento é iniciado. Valores válidos: PAUSE : Tarefa pausada. SKIP : Tarefa de dry-run. A tarefa é executada em um agendamento diário, mas seu status é definido diretamente como bem-sucedido quando o agendamento é iniciado. MANUAL : Tarefa manual. A tarefa não é executada em um agendamento diário e corresponde a um nó em um workflow manual. NORMAL : Tarefa de agendamento normal.	NORMAL
AdvancedSettings	string	Não	As configurações avançadas da tarefa. Este parâmetro corresponde à seção Advanced Settings no painel de navegação à direita da página de edição para tarefas de desenvolvimento de dados EMR Spark Streaming e EMR Streaming SQL no console do DataWorks. Apenas as tarefas EMR Spark Streaming e EMR Streaming SQL suportam este parâmetro. O valor do parâmetro deve estar no formato JSON. console do DataWorks	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
StartImmediately	boolean	Não	Especifica se a tarefa deve ser iniciada imediatamente após ser implantada. Valores válidos: true: Inicia a tarefa imediatamente após ela ser implantada. false: Não inicia a tarefa imediatamente após ela ser implantada. Este parâmetro corresponde ao parâmetro Start Mode na seção Configuration > Time Attributes > Start Mode no painel de navegação à direita da página de edição para tarefas de desenvolvimento de dados EMR Spark Streaming e EMR Streaming SQL no console do DataWorks. console do DataWorks	true
InputParameters	string	Não	Os parâmetros de entrada de contexto do nó. O valor do parâmetro deve estar no formato JSON. Para os campos incluídos, consulte a estrutura do parâmetro InputContextParameterList na resposta da operação GetFile. Este parâmetro corresponde ao parâmetro Input Parameters of Current Node na seção Schedule Settings > Node Context > Input Parameters do console do DataWorks. console do DataWorks	[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]
OutputParameters	string	Não	Os parâmetros de saída de contexto do nó. O valor do parâmetro deve estar no formato JSON. Para os campos incluídos, consulte a estrutura do parâmetro OutputContextParameterList na resposta da operação GetFile. Este parâmetro corresponde ao parâmetro Output Parameters of Current Node na seção Schedule Settings > Node Context > Output Parameters do console do DataWorks. console do DataWorks	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
IgnoreParentSkipRunningProperty	boolean	Não	Especifica se a propriedade de dry-run dos nós upstream no ciclo anterior deve ser ignorada.	true
ApplyScheduleImmediately	boolean	Não	Especifica se as configurações de agendamento entram em vigor imediatamente após o arquivo ser implantado.	true
Timeout	integer	Não	A definição de tempo limite nas configurações de agendamento.	1
ImageId	string	Não	O ID da imagem personalizada.	m-uf6d7npxk1hhek8ng0cb

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
RequestId	string	O ID exclusivo da solicitação. Você pode usar o ID para solucionar problemas quando ocorre um erro.	0000-ABCD-EFGH-IJKLMNOPQ
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
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

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFGH-IJKLMNOPQ",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Você não tem as permissões necessárias. Conceda as permissões primeiro.
429	Throttling.Api	The request for this resource has exceeded your available limit.
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.