Queries a list of user-defined functions (UDFs) in DataStudio. You can also specify filter conditions to query specific UDFs.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:* | list | *All Resources * |
| none |
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 user-defined function (UDF) type. This parameter specifies a filter condition. Valid values:
| 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 parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "89FB2BF0-EB00-5D03-9C34-05931001XXXX",
"PagingInfo": {
"TotalCount": 294,
"PageNumber": 1,
"PageSize": 10,
"Functions": [
{
"Name": "Function 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": "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": "odps_first",
"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
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-12-29 | The response structure of the API has changed | View Change Details |
| 2025-01-13 | The response structure of the API has changed | View Change Details |