Todos os produtos
Search

Este produto

    DataWorks:CreateUdfFile

    Central de documentação

    DataWorks:CreateUdfFile

    Última atualização: Oct 16, 2026

    Cria um arquivo de função no Data Studio.

    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 da pasta onde o arquivo de função está localizado.

    Business_process/First_Business_Process/function/string_processing
    ProjectId

    integer

    Não

    O ID do workspace do DataWorks. Você pode clicar no ícone de chave inglesa no canto superior direito da página para acessar a página de Gerenciamento de Workspace e visualizar o ID.

    10000
    FileName

    string

    Sim

    O nome da função.

    StringConcat
    FunctionType

    string

    Sim

    A categoria da função. Este parâmetro corresponde ao campo Tipo de Função na caixa de diálogo Criar Função. Valores válidos: MATH (funções de operação matemática), AGGREGATE (funções de agregação), STRING (funções de processamento de string), DATE (funções de processamento de data), ANALYTIC (funções de janela) e OTHER (outras funções).

    Valores válidos:

    • OTHER :

      Outras funções.

    • DATE :

      Funções de processamento de data.

    • AGGREGATE :

      Funções de agregação.

    • STRING :

      Funções de processamento de string.

    • ANALYTIC :

      Funções de janela.

    • MATH :

      Funções de operação matemática.

    STRING
    ClassName

    string

    Sim

    O nome da classe onde a função é definida. Este parâmetro corresponde ao campo Nome da Classe na caixa de diálogo Criar Função.

    com.alibaba.DataWorks.api.udf.StringConcat
    Resources

    string

    Sim

    A lista de nomes dos recursos referenciados pela função. Este parâmetro corresponde ao campo Recursos na caixa de diálogo Criar Função. Separe vários nomes de recursos com vírgulas (,).

    string-concat-1.0.0.jar,commons-lang-2.6.jar
    UdfDescription

    string

    Não

    A descrição do propósito da função. Este parâmetro corresponde ao campo Descrição na caixa de diálogo Criar Função.

    Concatenate several strings to generate a new string
    CmdDescription

    string

    Não

    O formato de comando para invocar a chamada da função. Este parâmetro corresponde ao campo Formato do Comando no formulário Criar Função.

    StringConcat(String... substrs)
    ParameterDescription

    string

    Não

    A descrição dos parâmetros de entrada da função. Este parâmetro corresponde ao campo de descrição de parâmetros no formulário Criar Função.

    List of strings to be connected
    ReturnValue

    string

    Não

    A descrição do valor de retorno da função. Este parâmetro corresponde ao campo Valor de Retorno na caixa de diálogo Criar Função.

    New strings generated by concatenating all strings before and after the input order
    Example

    string

    Não

    O exemplo para invocar a chamada da função. Este parâmetro corresponde ao campo Exemplo no formulário Criar Função.

    StringConcat('a', 'b', 'c')
    ProjectIdentifier

    string

    Não

    O identificador exclusivo do workspace do DataWorks. É o identificador em inglês exibido quando você alterna entre workspaces na parte superior da página do Data Studio.

    dw_project
    CreateFolderIfNotExists

    boolean

    Não

    Especifica se deve ser ativada a criação automática da pasta especificada pelo parâmetro FileFolderPath caso a pasta não exista no sistema. Valores válidos:\n\n- true: Ativa a criação automática da pasta caso ela não exista.\n\n- false: A chamada falha caso a pasta não exista.

    false

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    A estrutura de dados da resposta.

    HttpStatusCode

    integer

    O código de status HTTP.

    200
    Data

    integer

    O ID do arquivo criado.

    100000002
    RequestId

    string

    O ID exclusivo da solicitação. Você pode usar o ID para solucionar problemas caso ocorra 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.

    true
    ErrorCode

    string

    O código de erro.

    Invalid.Tenant.ConnectionNotExists

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "HttpStatusCode": 200,
  "Data": 100000002,
  "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.