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

Crea un archivo para una 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	Sí	La ruta de la carpeta que contiene el archivo de función.	Business_process/First_Business_Process/function/string_processing
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Para encontrarlo, haga clic en el icono de llave inglesa de la esquina superior derecha y vaya a la página de administración del espacio de trabajo.	10000
FileName	string	Sí	El nombre de la función.	StringConcat
FunctionType	string	Sí	La categoría de la función, correspondiente al campo de tipo de función del formulario Crear función. Valores válidos: MATH (funciones matemáticas), AGGREGATE (funciones de agregación), STRING (funciones de procesamiento de cadenas), DATE (funciones de procesamiento de fechas), ANALYTIC (funciones de ventana) y OTHER (otras funciones). Valores válidos: OTHER : 其他函数 DATE : 日期处理函数 AGGREGATE : 聚合函数 STRING : 字符串处理函数 ANALYTIC : 窗口函数 MATH : 数学运算函数	STRING
ClassName	string	Sí	El nombre de la clase en la que se define la función, correspondiente al campo de nombre de clase del formulario Crear función.	com.alibaba.DataWorks.api.udf.StringConcat
Resources	string	Sí	La lista separada por comas de nombres de recursos a los que hace referencia la función, correspondiente al campo de lista de recursos del formulario Crear función.	string-concat-1.0.0.jar,commons-lang-2.6.jar
UdfDescription	string	No	La descripción del propósito de la función, correspondiente al campo de 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, correspondiente al campo de formato de comando del formulario Crear función.	StringConcat(String... substrs)
ParameterDescription	string	No	La descripción de los parámetros de la función, correspondiente al campo de 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, correspondiente al campo de 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 que muestra cómo llamar a la función, correspondiente al campo de ejemplo del formulario Crear función.	StringConcat('a', 'b', 'c')
ProjectIdentifier	string	No	El identificador único del espacio de trabajo de DataWorks, que corresponde al identificador en inglés que aparece en la parte superior de la página de Data Studio donde se cambia de espacio de trabajo.	dw_project
CreateFolderIfNotExists	boolean	No	Especifica si se debe crear el directorio automáticamente si la ruta especificada (FileFolderPath) no existe. Valores válidos: true: crea el directorio automáticamente si no existe. false: la llamada falla si el directorio no existe.	false

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
Data	integer	El ID del archivo después de una creación correcta.	100000002
RequestId	string	El ID único de esta solicitud. Utilice este ID para solucionar problemas si se produce un error.	0000-ABCD-EFG****
ErrorMessage	string	El mensaje de error.	The connection does not exist.
Success	boolean	Indica si la solicitud se realizó correctamente. true false	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	Descripción
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.	Acceso denegado. Autorice primero.
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.