文档

GetFunction - 获取数据开发函数详情

更新时间:

获取指定数据开发udf函数的详细信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
ProjectIdstring

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。

该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

10000
Idstring

UDF 函数的唯一标识符

860438872620113XXXX

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID,用于后续错误排查使用。

6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX
Functionobject

udf 函数详细信息

Idstring

udf 函数唯一标识

860438872620113XXXX
ProjectIdstring

udf 函数所属的 DataWorks 工作空间 ID。

10000
Namestring

udf 函数的名称

函数名称
Ownerstring

udf 函数的责任人

110755000425XXXX
CreateTimelong

udf 函数的创建时间戳

1724505917000
ModifyTimelong

udf 函数的最近修改时间戳

1724506661000
Specstring

描述这个 udf 函数的 FlowSpec 信息,具体规范详见 FlowSpec

{ "version": "1.1.0", "kind": "Function", "spec": { "functions": [ { "name": "函数名称", "id": "580667964888595XXXX", "script": { "content": "{ \"uuid\": \"580667964888595XXXX\", \"name\": \"函数名称\", \"datasource\": { \"type\": \"odps\", \"name\": \"odps_first\" }, \"runtimeResource\": { \"resourceGroup\": \"S_res_group_XXXX_XXXX\", \"resourceGroupId\": 6591XXXX }}", "path": "XXX/OpenAPI/函数/函数名称", "runtime": { "command": "ODPS_FUNCTION" } }, "datasource": { "name": "odps_first", "type": "odps" }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "723932906364267XXXX", "resourceGroupId": "6591XXXX" }, "metadata": { "owner": "110755000425XXXX" } } ] } }

示例

正常返回示例

JSON格式

{
  "RequestId": "6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX",
  "Function": {
    "Id": "860438872620113XXXX\n",
    "ProjectId": "10000",
    "Name": "函数名称",
    "Owner": "110755000425XXXX",
    "CreateTime": 1724505917000,
    "ModifyTime": 1724506661000,
    "Spec": "{\n  \"version\": \"1.1.0\",\n  \"kind\": \"Function\",\n  \"spec\": {\n    \"functions\": [\n      {\n        \"name\": \"函数名称\",\n        \"id\": \"580667964888595XXXX\",\n        \"script\": {\n          \"content\": \"{  \\\"uuid\\\": \\\"580667964888595XXXX\\\",  \\\"name\\\": \\\"函数名称\\\",  \\\"datasource\\\": {    \\\"type\\\": \\\"odps\\\",    \\\"name\\\": \\\"odps_first\\\"  },  \\\"runtimeResource\\\": {    \\\"resourceGroup\\\": \\\"S_res_group_XXXX_XXXX\\\",    \\\"resourceGroupId\\\": 6591XXXX  }}\",\n          \"path\": \"XXX/OpenAPI/函数/函数名称\",\n          \"runtime\": {\n            \"command\": \"ODPS_FUNCTION\"\n          }\n        },\n        \"datasource\": {\n          \"name\": \"odps_first\",\n          \"type\": \"odps\"\n        },\n        \"runtimeResource\": {\n          \"resourceGroup\": \"S_res_group_XXXX_XXXX\",\n          \"id\": \"723932906364267XXXX\",\n          \"resourceGroupId\": \"6591XXXX\"\n        },\n        \"metadata\": {\n          \"owner\": \"110755000425XXXX\"\n        }\n      }\n    ]\n  }\n}"
  }
}

错误码

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