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

Cria um arquivo para uma função no DataStudio.

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	Sim	O caminho para a pasta que contém o arquivo da função.	Business_process/First_Business_Process/function/string_processing
ProjectId	integer	Não	O ID do workspace do DataWorks. Para encontrá-lo, clique no ícone de chave inglesa no canto superior direito e navegue até a página de gerenciamento do workspace.	10000
FileName	string	Sim	O nome da função.	StringConcat
FunctionType	string	Sim	A categoria da função, correspondente ao campo tipo de função no formulário Criar Função. Valores válidos: MATH (funções matemáticas), AGGREGATE (funções de agregação), STRING (funções de processamento de strings), DATE (funções de processamento de datas), ANALYTIC (funções de janela) e OTHER (outras funções).	STRING
ClassName	string	Sim	O nome da classe onde a função é definida, correspondente ao campo nome da classe no formulário Criar Função.	com.alibaba.DataWorks.api.udf.StringConcat
Resources	string	Sim	Uma lista separada por vírgulas de nomes de recursos referenciados pela função, correspondente ao campo lista de recursos no formulário Criar Função.	string-concat-1.0.0.jar,commons-lang-2.6.jar
UdfDescription	string	Não	A descrição da finalidade da função, correspondente ao campo descrição no formulário Criar Função.	Concatenate several strings to generate a new string
CmdDescription	string	Não	O formato do comando para invocar a função, correspondente ao campo formato do comando no formulário Criar Função.	StringConcat(String... substrs)
ParameterDescription	string	Não	A descrição dos parâmetros da função, correspondente ao campo descrição dos 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, correspondente ao campo valor de retorno no formulário Criar Função.	New strings generated by concatenating all strings before and after the input order
Example	string	Não	Um exemplo demonstrando como chamar a função, correspondente ao campo exemplo no formulário Criar Função.	StringConcat('a', 'b', 'c')
ProjectIdentifier	string	Não	O identificador exclusivo do workspace do DataWorks, que é o identificador no topo da página do Data Studio onde você alterna entre workspaces.	dw_project
CreateFolderIfNotExists	boolean	Não	Especifica se o diretório deve ser criado automaticamente caso o caminho especificado (FileFolderPath) 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

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 a criação bem-sucedida.	100000002
RequestId	string	O ID exclusivo desta solicitação. Use este ID para solução de 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 false.	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.	No permission, please authorize
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.