ListFunctions - 获取数据开发函数列表 - 大数据开发治理平台 DataWorks

调用此接口，可以分页获取数据开发中的udf函数列表，也可以使用筛选条件筛选udf函数。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProjectId	string	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。	12345
Owner	string	否	筛选条件：udf 函数的负责人 ID	110755000425XXXX
Type	string	否	筛选条件：函数类型可选值： Math：数学运算函数 Aggregate：聚合函数 String：字符串处理函数 Date：日期函数 Analytic：窗口函数 Other：其他函数	Math
PageNumber	integer	否	分页的页数。默认值为 1，最小值为 1。	1
PageSize	integer	否	每页显示的数据条数，默认为 10 条，最大为 100 条。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。用于出现错误后排查问题。	89FB2BF0-EB00-5D03-9C34-05931001XXXX
PagingInfo	object	分页信息
TotalCount	integer	满足条件的数据总条数。	294
PageNumber	integer	请求的数据页数，用于翻页。	1
PageSize	integer	每页显示的条数	10
Functions	array<object>	函数列表
function	object	函数列表元素信息
Id	string	udf 函数唯一标识符	580667964888595XXXX
Name	string	udf 函数名称	函数名称
CreateTime	long	udf 函数创建时间戳	1655953028000
ProjectId	string	udf 函数所在的项目 ID	307XXX
Owner	string	udf 函数的责任人	110755000425XXXX
Type	string	udf 函数类型可选值： Math：数学运算函数 Aggregate：聚合函数 String：字符串处理函数 Date：日期函数 Analytic：窗口函数 Other：其他函数	Math
ModifyTime	long	修改时间	1655953028000
ClassName	string	udf 函数的全限定类名	com.demo.Main
ArmResource	string	ARM 集群资源文件列表	xxx.jar,yyy.jar
FileResource	string	函数的实现代码，资源文件列表	xxx.jar,yyy.jar
Description	string	对于函数的总体描述	描述信息
CommandDescription	string	命令描述	testUdf(xx,yy)
ParameterDescription	string	参数描述	xx：参数信息XXX yy：参数信息YYY
ReturnValueDescription	string	返回值说明	返回值是一个字符串
ExampleDescription	string	示例说明	示例说明 >>> select tsetUdf(xx,yy); abc
EmbeddedCodeType	string	嵌套代码类型可选值 Python2 Python3 Java8 Java11 Java17	Python2
EmbeddedResourceType	string	嵌套资源类型可选值 File 普通资源文件 Embedded 嵌入式资源	File
EmbeddedCode	string	嵌套函数代码内容	print('hello,world!')
DatabaseName	string	数据库名，仅当 Function 类型为 EMR Function 时使用	EMR_lake
DataSource	object	udf 函数数据源信息
Name	string	数据源名称	odps_first
Type	string	数据源类型	odps
Script	object	udf 函数脚本信息
Path	string	脚本路径	XXX/OpenAPI/函数/函数名称
Runtime	object	运行时
Command	string	命令	ODPS_FUNCTION
Id	string	脚本 id	652567824470354XXXX
RuntimeResource	object	运行时资源组信息
ResourceGroupId	string	运行时资源组 Id	S_resgrop_xxx

示例

正常返回示例

JSON格式

{
  "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": "xx：参数信息XXX\nyy：参数信息YYY",
        "ReturnValueDescription": "返回值是一个字符串",
        "ExampleDescription": "示例说明\t>>> 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/函数/函数名称",
          "Runtime": {
            "Command": "ODPS_FUNCTION"
          },
          "Id": "652567824470354XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_resgrop_xxx"
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史