ListFunctions-阿里云帮助中心

Queries a list of user-defined functions (UDFs) in DataStudio. You can also specify filter conditions to query specific UDFs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	12345
Owner	string	No	The ID of the owner of the UDF. This parameter specifies a filter condition.	110755000425XXXX
Type	string	No	The user-defined function (UDF) type. This parameter specifies a filter condition. Valid values: Math: mathematical operation function Aggregate: aggregate function String: string processing function Date: date function Analytic: window function Other: other functions	Math
Name	string	No	Filter criteria: UDF name. Supports fuzzy search.	test
PageNumber	integer	No	The page number. Default value: 1. Minimum value: 1.	1
PageSize	integer	No	The page number. Default value: 1. Minimum value: 1.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	89FB2BF0-EB00-5D03-9C34-05931001XXXX
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	294
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Functions	array<object>	The function list.
	array<object>	Information about the elements in the function list.
Name	string	The UDF name.	Function name
CreateTime	integer	The timestamp when the UDF was created.	1655953028000
ProjectId	integer	The ID of the project to which the UDF belongs.	307XXX
Owner	string	The owner of the UDF.	110755000425XXXX
Type	string	The UDF type. Valid values: Math: Mathematical operation functions Aggregate: Aggregation functions String: String processing functions Date: Date functions Analytic: Window functions Other: Other functions	Math
ModifyTime	integer	The modification time.	1655953028000
ClassName	string	The fully qualified class name of the UDF.	com.demo.Main
ArmResource	string	The list of resource files for the ARM cluster.	xxx.jar,yyy.jar
FileResource	string	The implementation code of the function and the list of resource files.	xxx.jar,yyy.jar
Description	string	The general description of the function.	Description
CommandDescription	string	The command description.	testUdf(xx,yy)
ParameterDescription	string	The parameter description.	xx: parameter information XXX yy: parameter information YYY
ReturnValueDescription	string	The return value description.	The return value is a string.
ExampleDescription	string	The example description.	Example description >>> select tsetUdf(xx,yy); abc
EmbeddedCodeType	string	The nested code type. Valid values: Python2 Python3 Java8 Java11 Java17	Python2
EmbeddedResourceType	string	The nested resource type. Valid values: File: General resource file. Embedded: Embedded resource.	File
EmbeddedCode	string	Content of the nested function code	print('hello,world!')
DatabaseName	string	The database name. This parameter is used only when the function type is EMR Function.	EMR_lake
DataSource	object	Data source information of the UDF.
Name	string	The name of the data source.	odps_first
Type	string	The type of the data source.	odps
Script	object	Script information of the UDF.
Path	string	The script path.	XXX/OpenAPI/function/function_name
Runtime	object	Runtime
Command	string	Command	ODPS_FUNCTION
Id	string	The ID of the script. Note This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.	652567824470354XXXX
RuntimeResource	object	The runtime resource group information.
ResourceGroupId	string	The runtime resource group ID.	S_resgrop_xxx
Id	string	The unique identifier of the UDF. Note Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.	580667964888595XXXX

Examples

Success response

JSON format

{
  "RequestId": "89FB2BF0-EB00-5D03-9C34-05931001XXXX",
  "PagingInfo": {
    "TotalCount": 294,
    "PageNumber": 1,
    "PageSize": 10,
    "Functions": [
      {
        "Name": "Function name",
        "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": "Description",
        "CommandDescription": "testUdf(xx,yy)",
        "ParameterDescription": "xx: parameter information XXX\nyy: parameter information YYY",
        "ReturnValueDescription": "The return value is a string.",
        "ExampleDescription": "Example description >>> 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"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.