调用此接口，可以分页获取数据开发中的udf函数列表，也可以使用筛选条件筛选udf函数。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:* | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | long | 是 | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 | 12345 |
| Owner | string | 否 | 筛选条件：udf 函数的负责人 ID | 110755000425XXXX |
| Type | string | 否 | 筛选条件：函数类型 可选值：
| Math |
| Name | string | 否 | 筛选条件：udf 函数名称，支持模糊搜索。 | test |
| PageNumber | integer | 否 | 分页的页数。默认值为 1，最小值为 1。 | 1 |
| PageSize | integer | 否 | 每页显示的数据条数，默认为 10 条，最大为 100 条。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "89FB2BF0-EB00-5D03-9C34-05931001XXXX",
"PagingInfo": {
"TotalCount": 294,
"PageNumber": 1,
"PageSize": 10,
"Functions": [
{
"Id": 0,
"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": 0
},
"RuntimeResource": {
"ResourceGroupId": "S_resgrop_xxx"
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-01-13 | OpenAPI 返回结构发生变更 | 查看变更详情 |