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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*get
*全部资源
*

请求参数

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

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

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

10000
Idlong

UDF 函数的唯一标识符

86043887262011****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

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

udf 函数详细信息

Idlong

udf 函数唯一标识

860438872620113XXXX
ProjectIdlong

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

10000
Namestring

udf 函数的名称

Function name
Ownerstring

udf 函数的责任人

110755000425XXXX
CreateTimelong

udf 函数的创建时间戳

1724505917000
ModifyTimelong

udf 函数的最近修改时间戳

1724506661000
Specstring

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

{ "version": "1.1.0", "kind": "Function", "spec": { "functions": [ { "name": "Function_Name", "id": "580667964888595XXXX", "script": { "content": "{ \"uuid\": \"580667964888595XXXX\", \"name\": \"Function_Name\", \"datasource\": { \"type\": \"odps\", \"name\": \"odps_first\" }, \"runtimeResource\": { \"resourceGroup\": \"S_res_group_XXXX_XXXX\", \"resourceGroupId\": 6591XXXX }}", "path": "XXX/OpenAPI/Function/Function_Name", "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": 0,
    "ProjectId": 10000,
    "Name": "Function name",
    "Owner": "110755000425XXXX",
    "CreateTime": 1724505917000,
    "ModifyTime": 1724506661000,
    "Spec": {
      "version": "1.1.0",
      "kind": "Function",
      "spec": {
        "functions": [
          {
            "name": "Function_Name",
            "id": "580667964888595XXXX",
            "script": {
              "content": "{  \"uuid\": \"580667964888595XXXX\",  \"name\": \"Function_Name\",  \"datasource\": {    \"type\": \"odps\",    \"name\": \"odps_first\"  },  \"runtimeResource\": {    \"resourceGroup\": \"S_res_group_XXXX_XXXX\",    \"resourceGroupId\": 6591XXXX  }}",
              "path": "XXX/OpenAPI/Function/Function_Name",
              "runtime": {
                "command": "ODPS_FUNCTION"
              }
            },
            "datasource": {
              "name": "odps_first",
              "type": "odps"
            },
            "runtimeResource": {
              "resourceGroup": "S_res_group_XXXX_XXXX",
              "id": "723932906364267XXXX",
              "resourceGroupId": "6591XXXX"
            },
            "metadata": {
              "owner": "110755000425XXXX"
            }
          }
        ]
      }
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-01-13OpenAPI 返回结构发生变更查看变更详情