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

Obtiene una lista paginada de funciones UDF en Data Studio. También puede usar condiciones de filtro para filtrar funciones UDF.

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

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:*

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página de Administración de espacios de trabajo para obtener el ID. Este parámetro especifica el espacio de trabajo de DataWorks para esta operación de llamada a la API.	12345
Owner	string	No	La condición de filtro: el ID del propietario de la función UDF.	110755000425XXXX
Type	string	No	La condición de filtro: el tipo de 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 fecha Analytic: función de ventana Other: otra función	Math
Name	string	No	La condición de filtro: el nombre de la función UDF. Se admite la coincidencia aproximada.	test
PageNumber	integer	No	El número de página. Valor predeterminado: 1. Valor mínimo: 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud. Se utiliza para la solución de problemas cuando ocurre un error.	89FB2BF0-EB00-5D03-9C34-05931001XXXX
PagingInfo	object	La información de paginación.
TotalCount	integer	El número total de entradas que cumplen con las condiciones de filtro.	294
PageNumber	integer	El número de página de los datos devueltos. Se utiliza para la paginación.	1
PageSize	integer	El número de entradas por página.	10
Functions	array<object>	La lista de funciones.
	array<object>	La información sobre una función en la lista.
Name	string	El nombre de la función UDF.	Function name
CreateTime	integer	La marca de tiempo cuando se creó la función UDF.	1655953028000
ProjectId	integer	El ID del proyecto al que pertenece la función UDF.	307XXX
Owner	string	El propietario de la función UDF.	110755000425XXXX
Type	string	El tipo de la función UDF. 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 fecha Analytic: función de ventana Other: otra función	Math
ModifyTime	integer	La hora de modificación. El valor es un número de 13 dígitos, como `1655953028000`.	1655953028000
ClassName	string	El nombre de clase totalmente calificado de la función UDF.	com.demo.Main
ArmResource	string	La lista de archivos de recursos para el clúster de ARM.	xxx.jar,yyy.jar
FileResource	string	El código de implementación de la función. La lista de archivos de recursos.	xxx.jar,yyy.jar
Description	string	La descripción general de la función.	Description
CommandDescription	string	La descripción del comando.	testUdf(xx,yy)
ParameterDescription	string	La descripción del parámetro.	xx: parameter information XXX yy: parameter information YYY
ReturnValueDescription	string	La descripción del valor de retorno.	The return value is a string.
ExampleDescription	string	La descripción del ejemplo.	Example description >>> select tsetUdf(xx,yy); abc
EmbeddedCodeType	string	El tipo de código insertado. Valores válidos: Python2 Python3 Java8 Java11 Java17	Python2
EmbeddedResourceType	string	El tipo de recurso insertado. Valores válidos: File: archivo de recurso común Embedded: recurso insertado	File
EmbeddedCode	string	El contenido del código de la función insertada.	print('hello,world!')
DatabaseName	string	El nombre de la base de datos. Este campo se utiliza solo cuando el tipo de función es EMR Function.	EMR_lake
DataSource	object	La información del origen de datos de la función UDF.
Name	string	El nombre del origen de datos.	odps_first
Type	string	El tipo del origen de datos.	odps
Script	object	La información del script de la función UDF.
Path	string	La ruta del script.	XXX/OpenAPI/function/function_name
Runtime	object	El entorno de ejecución.
Command	string	El comando.	ODPS_FUNCTION
Id	string	El ID del script. Importante Este campo era de tipo Long en las versiones del SDK anteriores a la 8.0.0 y es de tipo String en el SDK 8.0.0 y versiones posteriores. Este cambio no afecta el uso normal del SDK. El parámetro aún se devuelve en el tipo definido en el SDK. Solo cuando actualiza el SDK a una versión posterior a la 8.0.0, el cambio de tipo puede causar errores de compilación del proyecto, y debe corregir manualmente el tipo de datos.	652567824470354XXXX
RuntimeResource	object	La información del grupo de recursos del entorno de ejecución.
ResourceGroupId	string	El ID del grupo de recursos del entorno de ejecución.	S_resgrop_xxx
Id	string	El identificador único de la función UDF. Importante Este campo era de tipo Long en las versiones del SDK anteriores a la 8.0.0 y es de tipo String en el SDK 8.0.0 y versiones posteriores. Este cambio no afecta el uso normal del SDK. El parámetro aún se devuelve en el tipo definido en el SDK. Solo cuando actualiza el SDK a una versión posterior a la 8.0.0, el cambio de tipo puede causar errores de compilación del proyecto, y debe corregir manualmente el tipo de datos.	580667964888595XXXX

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "89FB2BF0-EB00-5D03-9C34-05931001XXXX",
  "PagingInfo": {
    "TotalCount": 294,
    "PageNumber": 1,
    "PageSize": 10,
    "Functions": [
      {
        "Name": "Nombre de la función",
        "CreateTime": 1655953028000,
        "ProjectId": 0,
        "Owner": "110755000425XXXX",
        "Type": "Math",
        "ModifyTime": 1655953028000,
        "ClassName": "com.demo.Main",
        "ArmResource": "xxx.jar,yyy.jar",
        "FileResource": "xxx.jar,yyy.jar",
        "Description": "Descripción",
        "CommandDescription": "testUdf(xx,yy)",
        "ParameterDescription": "xx: información del parámetro XXX\nyy: información del parámetro YYY",
        "ReturnValueDescription": "El valor de retorno es una cadena",
        "ExampleDescription": "Descripción del ejemplo >>> select tsetUdf(xx,yy);\nabc",
        "EmbeddedCodeType": "Python2",
        "EmbeddedResourceType": "File",
        "EmbeddedCode": "print('hello,world!')",
        "DatabaseName": "EMR_lake",
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "Script": {
          "Path": "XXX/OpenAPI/function/function_name",
          "Runtime": {
            "Command": "ODPS_FUNCTION"
          },
          "Id": "652567824470354XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_resgrop_xxx"
        },
        "Id": "580667964888595XXXX"
      }
    ]
  }
}

Códigos de error

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.