Updates the basic information about a user-defined function (UDF) in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectId | string | Yes | The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. | 10000 |
| Id | string | Yes | The unique identifier of the UDF. Note
This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK.. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.
| 463497880880954XXXX |
| Spec | string | Yes | The unique identifier of the UDF. Note
Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.
| { "version": "1.1.0", "kind": "Function", "spec": { "functions": [ { "name": "FunctionName", "script": { "content": "{\"name\": \"FunctionName\", \"datasource\": {\"type\": \"odps\", \"name\": \"odps_first\"}, \"runtimeResource\": {\"resourceGroup\": \"S_res_group_XXXX_XXXX\"}}", "path": "XXX/OpenAPI/Function/FunctionName", "runtime": { "command": "ODPS_FUNCTION" } }, "datasource": { "name": "odps_first", "type": "odps" }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX" } } ] } } |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "12123960-CB2C-5086-868E-C6C1D024XXXX",
"Success": true
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-12-29 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2025-01-13 | The internal configuration of the API is changed, but the call is not affected | View Change Details |