調用GetFunction API擷取資料開發函數詳情-巨量資料開發治理平台 DataWorks-阿里雲

擷取指定資料開發udf函數的詳細資料。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	否	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。	10000
Id	string	是	UDF 函數的唯一識別碼。重要該欄位在 SDK8.0.0 版本之前為 Long 類型，SDK8.0.0 版本及之後為 String 類型。該變更不影響 SDK 正常使用，參數仍會按 SDK 中定義的類型返回。只有在跨 8.0.0 版本的 SDK 升級時，類型變更可能會導致專案編譯不通過，需要使用者手動修正資料類型。	86043887262011****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID，用於後續錯誤排查使用。	6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX
Function	object	udf 函數詳細資料
ProjectId	integer	udf 函數所屬的 DataWorks 工作空間 ID。	10000
Name	string	udf 函數的名稱	Function name
Owner	string	udf 函數的責任人	110755000425XXXX
CreateTime	integer	udf 函數的建立時間戳記	1724505917000
ModifyTime	integer	udf 函數的最近修改時間戳記	1724506661000
Spec	string	描述這個 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" } } ] } }
Id	string	udf 函數唯一標識。重要該欄位在 SDK8.0.0 版本之前為 Long 類型，SDK8.0.0 版本及之後為 String 類型。該變更不影響 SDK 正常使用，參數仍會按 SDK 中定義的類型返回。只有在跨 8.0.0 版本的 SDK 升級時，類型變更可能會導致專案編譯不通過，需要使用者手動修正資料類型。	860438872620113XXXX

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX",
  "Function": {
    "ProjectId": 10000,
    "Name": "Function name",
    "Owner": "110755000425XXXX",
    "CreateTime": 1724505917000,
    "ModifyTime": 1724506661000,
    "Spec": "{\n    \"version\": \"1.1.0\",\n    \"kind\": \"Function\",\n    \"spec\": {\n        \"functions\": [\n            {\n                \"name\": \"Function_Name\",\n                \"id\": \"580667964888595XXXX\",\n                \"script\": {\n                    \"content\": \"{  \\\"uuid\\\": \\\"580667964888595XXXX\\\",  \\\"name\\\": \\\"Function_Name\\\",  \\\"datasource\\\": {    \\\"type\\\": \\\"odps\\\",    \\\"name\\\": \\\"odps_first\\\"  },  \\\"runtimeResource\\\": {    \\\"resourceGroup\\\": \\\"S_res_group_XXXX_XXXX\\\",    \\\"resourceGroupId\\\": 6591XXXX  }}\",\n                    \"path\": \"XXX/OpenAPI/Function/Function_Name\",\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}",
    "Id": "860438872620113XXXX\n"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。