Todos os produtos
Search

Este produto

    DataWorks:CreateFile

    Central de documentação

    DataWorks:CreateFile

    Última atualização: Oct 16, 2026

    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

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    dataworks:*

    create

    *All resources.

    *

    		 Nenhuma Nenhuma

    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 de Configuração do 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 operação de API.

    10000
    FileName

    string

    Sim

    O nome do arquivo.

    File name
    FileDescription

    string

    Não

    A descrição do arquivo.

    This is the file description
    FileType

    integer

    Sim

    O tipo de código do arquivo. O formato do código varia de acordo com o tipo de arquivo. Para obter 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 em branco, 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 arquivo. Você pode encontrar uma tarefa do tipo correspondente no Operation Center, clicar com o botão direito do mouse na tarefa e selecionar View Code para visualizar o formato específico do código.

    SHOW TABLES;
    AutoRerunTimes

    integer

    Não

    O número 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 a ocorrência de um erro. Unidade: milissegundos. Valor máximo: 1800000, que indica 30 minutos.

    Este parâmetro corresponde à configuração Intervalo de Reexecução em Configuração de Agendamento > Atributos de Tempo > Reexecução Automática após Erro para uma tarefa de desenvolvimento de dados no console do DataWorks. A unidade de tempo para a configuração Intervalo de Reexecução no console é minutos. Certifique-se de converter o 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 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 após ser bem-sucedida ou falhar.

    Este parâmetro corresponde à configuração Modo de Reexecução em Configuração de Agendamento > Atributos de Tempo > Modo de Reexecução para uma tarefa de desenvolvimento de dados 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 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_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 Pausar Agendamento em Configuração de Agendamento > Atributos de Tempo > Tipo de Agendamento para uma tarefa de desenvolvimento de dados 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 Parâmetros em Configuração de Agendamento > Parâmetros para uma tarefa de desenvolvimento de dados no console do DataWorks. Para obter 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 é iniciado.

    Este parâmetro corresponde à hora de início na configuração Data de Vigência em Configuração de Agendamento > Atributos de Tempo > Data de Vigência para uma tarefa de desenvolvimento de dados no console do DataWorks. O valor é um carimbo de data/hora em milissegundos.

    1671608450000
    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 na configuração Data de Vigência em Configuração de Agendamento > Atributos de Tempo > Data de Vigência para uma tarefa de desenvolvimento de dados no console do DataWorks. O valor é um carimbo de data/hora em milissegundos.

    1671694850000
    CronExpress

    string

    Não

    A expressão cron para agendamento periódico. Este parâmetro corresponde à configuração Expressão cron em Configuração de Agendamento > Propriedade de Tempo > Expressão cron para um nó 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 a tarefa às 05:30 todos os dias: 00 30 05 * * ?

    • Agendar a tarefa 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 a tarefa às 00:20 no primeiro dia de cada mês: 00 20 00 1 * ?

    • Agendar a tarefa a cada três meses a partir das 00:10 de 1º de janeiro: 00 10 00 1 1-12/3 ?

    • Agendar 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, a expressão cron tem 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 05 00 * * ?
    CycleType

    string

    Não

    O tipo do ciclo de agendamento. Valores válidos: NOT_DAY (minuto ou hora) e DAY (dia, semana ou mês).

    Este parâmetro corresponde à configuração Ciclo de Agendamento em Configuração de Agendamento > Atributos de Tempo > Ciclo de Agendamento para uma tarefa de desenvolvimento de dados no console do DataWorks.

    Valores válidos:

    • NOT_DAY :

      Agendado por minuto ou hora.

    • DAY :

      Agendado por dia, semana ou mês.

    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

    A lista de nós dos quais o nó atual depende no ciclo anterior.

    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ó Pai quando Mesmo Ciclo é selecionado em Configuração de Agendamento > Dependências de Agendamento para uma tarefa de desenvolvimento de dados no console do DataWorks.

    project_root,project.file1,project.001_out
    OutputList

    string

    Não

    Os nomes de saída do arquivo. Separe vários nomes de saída com vírgulas (,). Este parâmetro corresponde à configuração Nome de Saída do Nó Atual em Configuração de Agendamento > Dependências de Agendamento para uma tarefa de desenvolvimento de dados.

    project_root,project.file1,project.001_out
    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 de Configuração do 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 operação de API.

    dw_project
    ResourceGroupIdentifier

    string

    Não

    O grupo de recursos usado para executar a tarefa após a implantação do arquivo. Você pode chamar a operação ListResourceGroups e obter a lista de grupos de recursos disponíveis para o espaço de trabalho no campo identifier.

    Nota

    Certifique-se de que os grupos de recursos retornados pela operação ListResourceGroups estejam vinculados ao espaço de trabalho onde o arquivo é criado. Apenas grupos de recursos vinculados podem ser usados na operação CreateFile.

    group_375827434852437
    ResourceGroupId

    integer

    Não

    [Descontinuado] Não use este parâmetro.

    O grupo de recursos usado para executar a tarefa após a implantação do arquivo. Este parâmetro corresponde à configuração Grupo de Recursos de Agendamento em Configuração de Agendamento > Atributos de Recursos na página. Você pode especificar este parâmetro ou o parâmetro ResourceGroupIdentifier.

    Você pode chamar a operação ListResourceGroups para obter a lista de grupos de recursos disponíveis para o espaço de trabalho. Defina ResourceGroupType como 1 e obtenha o campo ID do resultado.

    375827434852437
    ConnectionName

    string

    Não

    A fonte de dados conectada quando a tarefa é executada após a implantação do arquivo. Você pode chamar a operação UpdateDataSource para obter a lista de fontes de dados disponíveis para o espaço de trabalho.

    odps_source
    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 à configuração Análise de Código quando Mesmo Ciclo é selecionado em Configuração de Agendamento > Dependências de Agendamento para uma tarefa de desenvolvimento de dados 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 trabalho 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 trabalho manual.

    • NORMAL :

      Tarefa de agendamento normal.

    NORMAL
    AdvancedSettings

    string

    Não

    As configurações avançadas da tarefa.

    Este parâmetro corresponde à seção Configurações Avançadas 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 oferecem suporte a este parâmetro, e o valor 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 implantada.

    Este parâmetro corresponde à configuração Método de Inicialização em Configuração > Atributos de Tempo > Método de Inicialização 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 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 Parâmetros de Entrada do Nó Atual em Configuração de Agendamento > Contexto do Nó para uma tarefa de desenvolvimento de dados 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 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 Parâmetros de Saída do Nó Atual em Configuração de Agendamento > Contexto do Nó para uma tarefa de desenvolvimento de dados no console do DataWorks.

    [{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
    IgnoreParentSkipRunningProperty

    boolean

    Não

    Especifica se a propriedade de dry-run deve ser herdada 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 a criação automática do diretório especificado pelo parâmetro FileFolderPath deve ser ativada caso ele não exista no sistema. Valores válidos:

    • true: Ativa a criação automática do diretório caso ele não exista.

    • 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 a implantação.

    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 estrutura da resposta.

    HttpStatusCode

    integer

    O código de status HTTP.

    200
    Data

    integer

    O ID do arquivo após a sua criação.

    1000001
    RequestId

    string

    O ID exclusivo da solicitação. Você pode usar o 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 solicitação foi bem-sucedida. Valores válidos:

    • true: A solicitação foi bem-sucedida.

    • false: A solicitação 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.