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

Atualiza um arquivo existente.

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 onde o arquivo está armazenado.	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, chamar a operação UpdateFile, especificar o ID do arquivo consultado no parâmetro FileId e configurar 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 de 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 de código específico.	SELECT "1";
AutoRerunTimes	integer	Não	O número de reexecuções automáticas permitidas após a ocorrência de um erro.	3
AutoRerunIntervalMillis	integer	Não	O intervalo entre reexecuções automáticas após uma falha, em milissegundos. O valor máximo é 1800000, que indica 30 minutos. Este parâmetro corresponde ao parâmetro Rerun Interval na seção Schedule > Time Attributes > Auto Rerun upon Failure do console do DataWorks. A unidade do parâmetro Rerun Interval no console é minutos. Converta a unidade de tempo ao chamar esta operação.	120000
RerunMode	string	Não	O modo de reexecução. Valores válidos: ALL_ALLOWED: A tarefa pode ser reexecutada independentemente de ser executada com sucesso ou falhar. FAILURE_ALLOWED: A tarefa pode ser reexecutada somente após falhar. ALL_DENIED: A tarefa não pode ser reexecutada independentemente de ser executada com sucesso ou falhar. Este parâmetro corresponde ao parâmetro Rerun Mode na seção Schedule > Time Attributes do console do DataWorks. Valores válidos: ALL_ALLOWED : Tudo permitido. ALL_DENIED : Tudo negado. ALL_ALLOWD : Tudo permitido. FAILURE_ALLOWED : Permitido após falha.	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 > Time Attributes > Schedule Type do console do DataWorks.	false
ParaValue	string	Não	Os parâmetros de agendamento. Este parâmetro corresponde à seção Scheduling Parameters na seção Schedule do console do DataWorks. Para mais informações, consulte Parâmetros de agendamento.	x=a y=b z=c
StartEffectDate	integer	Não	A hora de início do agendamento automático, na forma de um timestamp em milissegundos. Este parâmetro corresponde à hora de início na seção Schedule > Time Attributes > Effective Date do console do DataWorks.	936923400000
EndEffectDate	integer	Não	A hora de término do agendamento automático, na forma de um timestamp em milissegundos. Este parâmetro corresponde à hora de término na seção Schedule > Time Attributes > Effective Date do console do DataWorks.	4155787800000
CronExpress	string	Não	A expressão cron para agendamento periódico. Este parâmetro corresponde à expressão cron na seção Schedule > Time Property para a tarefa de desenvolvimento de dados no console do DataWorks. Depois de configurar o ciclo de agendamento e o horário de agendamento cronometrado, o DataWorks gera automaticamente a expressão cron correspondente. Exemplos: Agendar uma tarefa às 05:30 todos os dias: `00 30 05 * * ?`. Agendar uma tarefa no 15º minuto de cada hora: `00 15 * * * ?`. Agendar uma tarefa a cada 10 minutos: `00 00/10 * * * ?`. Agendar uma tarefa a cada 10 minutos das 08:00 às 17:00 todos os dias: `00 00-59/10 8-23 * * * ?`. Agendar uma tarefa às 00:20 no primeiro dia de cada mês: `00 20 00 1 * ?`. Agendar uma tarefa a cada três meses a partir das 00:10 de 1º de janeiro: `00 10 00 1 1-12/3 ?`. Agendar uma tarefa à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 (minutos e horas) e DAY (dias, semanas e meses). Este parâmetro corresponde ao parâmetro Schedule Type na seção Schedule > Time Attributes do console do DataWorks. Valores válidos: NOT_DAY : Minutos e horas. DAY : Dias, semanas e meses.	NOT_DAY
DependentType	string	Não	A dependência do ciclo anterior. Valores válidos: SELF: O nó atual. CHILD: Os nós filhos no primeiro nível. USER_DEFINE: Outros nós. NONE: Sem dependência do ciclo anterior. Valores válidos: CHILD_AND_SELF : Nó atual e nós downstream. USER_DEFINE : Nós especificados. SELF : Nó atual. USER_DEFINE_AND_SELF : Nós especificados e nó atual. NONE : Nenhum. CHILD : Nós downstream.	USER_DEFINE
DependentNodeIdList	string	Não	Os IDs dos nós dos quais o arquivo atual depende quando as configurações do parâmetro DependentType são definidas como USER_DEFINE. Separe vários IDs de nós com vírgulas (,). Este parâmetro corresponde ao conteúdo configurado quando você define o parâmetro Dependency como Cross-cycle Dependency (Previous Cycle) e seleciona Other Nodes na seção Schedule > Scheduling Dependencies para o 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 Output Name of Upstream Node na seção Schedule > Scheduling Dependencies do console do DataWorks. Nota Este parâmetro é obrigatório quando você cria uma tarefa de sincronização offline chamando a operação CreateDISyncTask ou UpdateFile.	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 de Configurações do Workspace 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 > Scheduling Dependencies do console do DataWorks.	dw_project.ods_user_info_d
ResourceGroupIdentifier	string	Não	O grupo de recursos usado quando a tarefa é executada após o arquivo ser publicado 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 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 ao parâmetro Code Parsing na seção Schedule > Scheduling Dependencies do console do DataWorks.	true
SchedulerType	string	Não	O tipo de agendamento. Valores válidos: NORMAL: Tarefa de agendamento normal. MANUAL: Tarefa manual. Não é agendada diariamente e corresponde a um nó em um workflow manual. PAUSE: Tarefa pausada. SKIP: Tarefa de dry-run. É agendada diariamente, mas seu status é definido diretamente como bem-sucedido quando o agendamento é acionado. Valores válidos: PAUSE : Tarefa pausada. SKIP : Tarefa de dry-run. É agendada diariamente, mas seu status é definido diretamente como bem-sucedido quando o agendamento é acionado. MANUAL : Tarefa manual. Não é agendada diariamente 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. Atualmente, apenas as tarefas EMR Spark Streaming e EMR Streaming SQL suportam este parâmetro, e o valor do parâmetro deve estar no formato JSON.	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
StartImmediately	boolean	Não	Especifica se a tarefa deve ser iniciada imediatamente após ser publicada. Valores válidos: true: Inicia a tarefa imediatamente após ela ser publicada. false: Não inicia a tarefa imediatamente após ela ser publicada. Este parâmetro corresponde ao parâmetro Startup Method na seção Configuration > Time Attributes 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.	true
InputParameters	string	Não	Os parâmetros de entrada de contexto do nó. O valor do parâmetro está 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 > Node Context Parameters do 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 está 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 > Node Context Parameters do console do DataWorks.	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
IgnoreParentSkipRunningProperty	boolean	Não	Este parâmetro corresponde ao parâmetro Skip Dry Run of Upstream Nodes que é configurado quando você define o parâmetro Dependency como Cross-cycle Dependency (Previous Cycle) e seleciona Current Node ou Child Nodes at First Level na seção Schedule > Scheduling Dependencies do console do DataWorks.	true
ApplyScheduleImmediately	boolean	Não	Especifica se a configuração de agendamento entra em vigor imediatamente após o arquivo ser publicado.	true
Timeout	integer	Não	A definição de tempo limite na configuração de agendamento.	1
ImageId	string	Não	O ID da imagem personalizada.	m-uf6d7npxk1hhek8ng0cb

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado retornado.
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 ocorrer um erro.	0000-ABCD-EFGH-IJKLMNOPQ
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada 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.