ListFunctions - DataWorks - Alibaba Cloud Documentation Center

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	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 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: others Enumeration Value: Analytic: Analytic. String: String. Math: Math. Aggregate: Aggregate. Date: Date. Other: Other.	MATH
PageNumber	integer	No	The page number. Default value: 1. Minimum value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
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 UDFs.
function	object	The information about the UDF.
Id	string	The ID of the UDF.	580667964888595XXXX
Name	string	The name of the UDF.
CreateTime	long	The time when the UDF was created. This value is a UNIX timestamp.	1655953028000
ProjectId	string	The ID of the workspace to which the UDF belongs.	307XXX
Owner	string	The owner of the UDF.	110755000425XXXX
Type	string	The UDF type. Valid values: Math: mathematical operation function Aggregate: aggregate function String: string processing function Date: date function Analytic: window function Other: other functions	MATH
ModifyTime	long	The time when the UDF was last modified. This value is a UNIX timestamp.	1655953028000
ClassName	string	The fully qualified class name of the UDF.	com.demo.Main
ArmResource	string	The file resources in an Advanced RISC Machines (ARM) cluster.	xxx.jar,yyy.jar
FileResource	string	The files resources.	xxx.jar,yyy.jar
Description	string	The overall description of the UDF.
CommandDescription	string	The description of the command.	testUdf(xx,yy)
ParameterDescription	string	The description of the parameter.
ReturnValueDescription	string	The description of the return value.
ExampleDescription	string	The description of the example.
EmbeddedCodeType	string	The type of the nested code. Valid values: Python2 Python3 Java8 Java11 Java17	Python2
EmbeddedResourceType	string	The type of the nested resource. Valid values: File: general resources Embedded: embedded resources	File
EmbeddedCode	string	The code of the embedded UDF.	print('hello,world!')
DatabaseName	string	The name of the database. This parameter is returned for E-MapReduce (EMR) functions.	odps_first
DataSource	object	The data source information about the UDF.
Name	string	The name of the data source.	odps_first
Type	string	The type of the data source.	odps
Script	object	The script information about the UDF.
Path	string	The script path.
Runtime	object	The runtime.
Command	string	The command.	ODPS_FUNCTION
Id	string	The script ID.	652567824470354XXXX
RuntimeResource	object	The information about the resource group used when you run the UDF.
ResourceGroupId	string	The ID of the resource group used when you run the UDF.	S_resgrop_xxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "89FB2BF0-EB00-5D03-9C34-05931001XXXX",
  "PagingInfo": {
    "TotalCount": 294,
    "PageNumber": 1,
    "PageSize": 10,
    "Functions": [
      {
        "Id": "580667964888595XXXX",
        "Name": "",
        "CreateTime": 1655953028000,
        "ProjectId": "307XXX",
        "Owner": "110755000425XXXX",
        "Type": "MATH",
        "ModifyTime": 1655953028000,
        "ClassName": "com.demo.Main",
        "ArmResource": "xxx.jar,yyy.jar",
        "FileResource": "xxx.jar,yyy.jar",
        "Description": "",
        "CommandDescription": "testUdf(xx,yy)",
        "ParameterDescription": "",
        "ReturnValueDescription": "",
        "ExampleDescription": "",
        "EmbeddedCodeType": "Python2",
        "EmbeddedResourceType": "File",
        "EmbeddedCode": "print('hello,world!')",
        "DatabaseName": "odps_first",
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "Script": {
          "Path": "",
          "Runtime": {
            "Command": "ODPS_FUNCTION"
          },
          "Id": "652567824470354XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_resgrop_xxx"
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history