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

Cria um arquivo no Data Studio. Esta operação não oferece suporte à criação de tarefas de nó de integração de dados.

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/MaxCompute/Folder_1/Folder_2
ProjectId	integer	Não	O ID do espaço de trabalho do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Gerenciamento de Espaço de Trabalho para obter o ID do espaço de trabalho. Você deve especificar este parâmetro ou o parâmetro ProjectIdentifier para determinar o espaço de trabalho do DataWorks para esta chamada de API.	10000
FileName	string	Sim	O nome do arquivo.	File name
FileDescription	string	Não	A descrição do arquivo.	test
FileType	integer	Sim	O tipo de código do arquivo. Diferentes tipos de arquivo possuem diferentes formatos de código. Para mais informações, consulte Tipos de nó do DataWorks. Você pode chamar a operação ListFileType para consultar o tipo de código do arquivo.	10
Owner	string	Não	O ID de usuário do Alibaba Cloud do proprietário do arquivo. Se este parâmetro for deixado vazio, o ID de usuário do Alibaba Cloud do chamador será usado por padrão.	1000000000001
Content	string	Não	O conteúdo do código do arquivo. O formato do código varia de acordo com o tipo de código (fileType) do arquivo. Você pode encontrar uma tarefa do tipo correspondente no Operation Center, clicar com o botão direito do mouse na tarefa e selecionar Ver Código para visualizar o formato específico do código.	SHOW TABLES;
AutoRerunTimes	integer	Não	O número máximo de reexecuções automáticas após a ocorrência de um erro. Valor máximo: 10.	3
AutoRerunIntervalMillis	integer	Não	O intervalo entre reexecuções automáticas após uma falha, em milissegundos. Valor máximo: 1800000 (30 minutos). Este parâmetro corresponde à configuração Intervalo de Reexecução em Configurações de Agendamento > Atributos de Tempo > Reexecução Automática após Falha para uma tarefa do Data Studio no console do DataWorks. A unidade de tempo para o Intervalo de Reexecução no console é em minutos. Converta o tempo adequadamente ao chamar esta operação.	120000
RerunMode	string	Não	A política de reexecução. Valores válidos: ALL_ALLOWED: A tarefa pode ser reexecutada após ser bem-sucedida ou falhar. FAILURE_ALLOWED: A tarefa não pode ser reexecutada após ser bem-sucedida, mas pode ser reexecutada após falhar. ALL_DENIED: A tarefa não pode ser reexecutada independentemente de ser bem-sucedida ou falhar. Este parâmetro corresponde à configuração Política de Reexecução em Configurações de Agendamento > Atributos de Tempo > Política de Reexecução para uma tarefa do Data Studio no console do DataWorks. Valores válidos: ALL_ALLOWED : A tarefa pode ser reexecutada após ser bem-sucedida ou falhar. ALL_DENIED : A tarefa não pode ser reexecutada independentemente de ser bem-sucedida ou falhar. FAILURE_ALLOWED : A tarefa não pode ser reexecutada após ser bem-sucedida, mas pode ser reexecutada após falhar.	ALL_ALLOWED
Stop	boolean	Não	Especifica se deve pausar o agendamento. Valores válidos: true: Pausa o agendamento. false: Não pausa o agendamento. Este parâmetro corresponde à definição de Configurações de Agendamento > Atributos de Tempo > Tipo de Agendamento como Pausar Agendamento para uma tarefa do Data Studio no console do DataWorks.	false
ParaValue	string	Não	Os parâmetros de agendamento. Separe vários parâmetros com espaços. Este parâmetro corresponde à configuração Configurações de Agendamento > Parâmetros de Agendamento para uma tarefa do Data Studio no console do DataWorks. Para mais informações, consulte Parâmetros de agendamento.	a=x b=y
StartEffectDate	integer	Não	O carimbo de data/hora em milissegundos em que o agendamento automático começa. Este parâmetro corresponde à hora de início em milissegundos configurada em Configurações de Agendamento > Atributos de Tempo > Data Efetiva para uma tarefa do Data Studio no console do DataWorks.	1671608450000
EndEffectDate	integer	Não	O carimbo de data/hora em milissegundos em que o agendamento automático para. Este parâmetro corresponde à hora de término em milissegundos configurada em Configurações de Agendamento > Atributos de Tempo > Data Efetiva para uma tarefa do Data Studio no console do DataWorks.	1671694850000
CronExpress	string	Não	A expressão cron para agendamento periódico. Este parâmetro corresponde à configuração Configurações de Agendamento > Propriedade de Tempo > Expressão Cron para uma tarefa do Data Studio 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: agendamento cronometrado às 05:30 todos os dias: `00 30 05 * * ?` agendamento cronometrado no 15º minuto de cada hora: `00 15 00-23/1 * * ?` Agendar a tarefa a cada 10 minutos: `00 00/10 * * * ?` Agendar a tarefa a cada 10 minutos das 08:00 às 17:00 todos os dias: `00 00-59/10 8-17 * * * ?` Agendar automaticamente a tarefa às 00:20 no 1º dia de cada mês: `00 20 00 1 * ?` Agendar a tarefa a cada 3 meses a partir das 00:10 de 1º de janeiro: `00 10 00 1 1-12/3 ?` Agendar automaticamente a 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 todos os dias é 00:05.	00 05 00 * * ?
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 à configuração Configurações de Agendamento > Atributos de Tempo > Ciclo de Agendamento para uma tarefa do Data Studio no console do DataWorks. Valores válidos: NOT_DAY : Minutos e horas. DAY : Dias, semanas e meses.	DAY
DependentType	string	Não	A dependência do ciclo anterior. Valores válidos: SELF: Depende do nó atual. CHILD: Depende dos nós filho de primeiro nível. USER_DEFINE: Depende de outros nós. NONE: Não depende do ciclo anterior. USER_DEFINE_AND_SELF: Depende de uma combinação do nó atual e de outros nós entre ciclos. CHILD_AND_SELF: Depende de uma combinação dos nós filho de primeiro nível e do nó atual entre ciclos. Valores válidos: CHILD_AND_SELF : Depende de uma combinação dos nós filho de primeiro nível e do nó atual entre ciclos. USER_DEFINE : Depende de outros nós. SELF : Depende do nó atual. USER_DEFINE_AND_SELF : Depende de uma combinação do nó atual e de outros nós entre ciclos. NONE : Não depende do ciclo anterior. CHILD : Depende dos nós filho de primeiro nível.	NONE
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 USER_DEFINE. Separe vários IDs de nó com vírgulas (,). Este parâmetro corresponde às Configurações quando você define Configurações de Agendamento > Dependências de Agendamento como Dependências entre Ciclos (anteriormente Ciclo Anterior) e seleciona Outros Nós para uma tarefa do Data Studio no console do DataWorks.	abc
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 à configuração Nome de Saída do Nó Upstream em Configurações de Agendamento > Dependências de Agendamento para uma tarefa do Data Studio no console do DataWorks.	project_root,project.file1,project.001_out
OutputList	string	Não	A saída do arquivo. Este parâmetro corresponde à configuração Nome de Saída do Nó Atual em Configurações de Agendamento > Dependências de Agendamento para uma tarefa do Data Studio no console do DataWorks.	dw_project.ods_user_info_d
ProjectIdentifier	string	Não	O nome do espaço de trabalho do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Gerenciamento de Espaço de Trabalho para obter o nome do espaço de trabalho. Você deve especificar este parâmetro ou o parâmetro ProjectId para determinar o espaço de trabalho do DataWorks para esta chamada de API.	dw_project
ResourceGroupIdentifier	string	Não	O grupo de recursos usado para executar a tarefa após o arquivo ser publicado como uma tarefa. Você pode fazer logon no console do DataWorks, acessar a página Gerenciamento de Espaço de Trabalho e clicar em Grupos de Recursos no painel de navegação à esquerda para obter o ID do grupo de recursos vinculado ao espaço de trabalho atual.	S_res_group_559_1613715566828
ResourceGroupId	integer	Não	[Obsoleto] Não use este campo.	375827434852437
ConnectionName	string	Não	A fonte de dados conectada quando a tarefa é executada após o arquivo ser publicado como uma tarefa. Você pode chamar a operação UpdateDataSource para obter a lista de fontes de dados disponíveis no espaço de trabalho.	odps_source
AutoParsing	boolean	Não	Especifica se deve ativar a análise automática para o arquivo. Valores válidos: true: Analisa automaticamente o código no arquivo. false: Não analisa automaticamente o código no arquivo. Este parâmetro corresponde à configuração de análise de código em Configurações de Agendamento > Dependências de Agendamento para uma tarefa do Data Studio no 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 é executada em um agendamento diário e corresponde a um nó em um fluxo de negócios manual. PAUSE: Tarefa pausada. SKIP: Tarefa de dry-run. É executada em um agendamento diário, mas seu status é definido diretamente como bem-sucedido quando o agendamento é acionado. Valores válidos: PAUSE : Tarefa pausada. SKIP : Tarefa de dry-run. É executada em um agendamento diário, mas seu status é definido diretamente como bem-sucedido quando o agendamento é acionado. MANUAL : Tarefa manual. Não é executada em um agendamento diário e corresponde a um nó em um fluxo de negócios manual. NORMAL : Tarefa de agendamento normal.	NORMAL
AdvancedSettings	string	Não	As configurações avançadas da tarefa. Este parâmetro corresponde às Configurações Avançadas no painel de navegação à direita da página de edição para tarefas do Data Studio EMR Spark Streaming e EMR Streaming SQL no console do DataWorks. Atualmente, apenas as tarefas EMR Spark Streaming e EMR Streaming SQL oferecem suporte a 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 deve iniciar a tarefa imediatamente após ela ser publicada. Este parâmetro corresponde à configuração Configuração > Atributos de Tempo > Modo de Início no painel de navegação à direita da página de edição para tarefas do Data Studio 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 à configuração Configurações de Agendamento > Parâmetros de Contexto do Nó > Parâmetros de Entrada do Nó Atual para uma tarefa do Data Studio no 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 à configuração Configurações de Agendamento > Parâmetros de Contexto do Nó > Parâmetros de Saída do Nó Atual para uma tarefa do Data Studio no console do DataWorks.	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
IgnoreParentSkipRunningProperty	boolean	Não	Especifica se deve herdar a propriedade de dry-run do ciclo anterior. Valores válidos: true: Herda a propriedade de dry-run do ciclo anterior. false: Não herda a propriedade de dry-run do ciclo anterior.	false
CreateFolderIfNotExists	boolean	Não	Especifica se deve criar automaticamente o diretório especificado pelo parâmetro FileFolderPath caso o diretório não exista. Valores válidos: true: Cria automaticamente o diretório se ele não existir. false: A chamada falha se o diretório não existir.	false
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-bp1h4b5a8ogkbll2f3tr

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
HttpStatusCode	integer	O código de status HTTP.	200
Data	integer	O ID do arquivo após ser criado.	1000001
RequestId	string	O ID exclusivo da solicitação. Você pode usar este ID para solucionar problemas quando ocorrer um erro.	0000-ABCD-EFG
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.	true
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists

Exemplos

Resposta de sucesso

JSON formato

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

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.