CreateUdfFile - DataWorks - Centro de documentación de Alibaba Cloud

Crea un archivo de tipo función en Data Studio.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
FileFolderPath	string	No	La ruta de la carpeta donde se almacena el archivo de función.	Business_process/First_Business_Process/function/string_processing
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Puede hacer clic en el icono de la llave pequeña en la esquina superior derecha de la página para ir a la página de gestión del espacio de trabajo y ver el ID.	10000
FileName	string	Sí	El nombre de la función.	StringConcat
FunctionType	string	Sí	La clasificación de la función, que corresponde al campo Tipo de función del formulario Crear función. Valores válidos: MATH (función de operación matemática), AGGREGATE (funciones de agregación), STRING (función de procesamiento de cadenas de caracteres), DATE (función de procesamiento de fechas), ANALYTIC (función de ventana) y OTHER (función de otro tipo). Valores válidos: OTHER : Función de otro tipo. DATE : Función de procesamiento de fechas. AGGREGATE : Funciones de agregación. STRING : Función de procesamiento de cadenas de caracteres. ANALYTIC : Función de ventana. MATH : Función de operación matemática.	STRING
ClassName	string	Sí	El nombre de la clase en la que se define la función, que corresponde al campo Nombre de clase del formulario Crear función.	com.alibaba.DataWorks.api.udf.StringConcat
Resources	string	Sí	Los recursos a los que hace referencia la función, correspondientes al campo Recursos del formulario Crear función. Separe varios nombres de recursos con comas (,).	string-concat-1.0.0.jar,commons-lang-2.6.jar
UdfDescription	string	No	La descripción del propósito de la función, que corresponde al campo Descripción del formulario Crear función.	Concatenate several strings to generate a new string
CmdDescription	string	No	El formato de comando para invocar la función, que corresponde al campo Formato de comando del formulario Crear función.	StringConcat(String... substrs)
ParameterDescription	string	No	La descripción de los parámetros de entrada de la función, que corresponde al campo Descripción de parámetros del formulario Crear función.	List of strings to be connected
ReturnValue	string	No	La descripción del valor de retorno de la función, que corresponde al campo Valor de retorno del formulario Crear función.	New strings generated by concatenating all strings before and after the input order
Example	string	No	El ejemplo de invocación de la función, que corresponde al campo Ejemplo del formulario Crear función.	StringConcat('a', 'b', 'c')
ProjectIdentifier	string	No	El identificador único del espacio de trabajo de DataWorks, que es el identificador en inglés que se muestra en el selector de espacio de trabajo en la parte superior de la página de Data Studio.	dw_project
CreateFolderIfNotExists	boolean	No	Especifica si se debe habilitar la creación automática del directorio especificado por el parámetro FileFolderPath si no existe. Valores válidos: true: crea automáticamente el directorio si no existe. false: la invocación falla si el directorio no existe.	false

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
HttpStatusCode	integer	El código de estado HTTP.	200
Data	integer	El ID del archivo una vez creado.	100000002
RequestId	string	El ID único de la solicitud. Puede usar este ID para solucionar problemas.	0000-ABCD-EFG****
ErrorMessage	string	El mensaje de error.	The connection does not exist.
Success	boolean	Indica si la llamada se realizó correctamente.	true
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "Data": 100000002,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "La conexión no existe",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
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.
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.