All Products
Search
Document Center

DataWorks:GetFunction

Last Updated:Dec 10, 2024

Queries the information about a user-defined function (UDF) in DataStudio.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdstringNo

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.

You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.

10000
IdstringYes

The ID of the UDF.

860438872620113XXXX

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The information about the UDF.

Idstring

The ID of the UDF.

860438872620113XXXX
ProjectIdstring

The ID of the DataWorks workspace to which the UDF belongs.

10000
Namestring

The name of the UDF.

Ownerstring

The owner of the UDF.

110755000425XXXX
CreateTimelong

The time when the UDF was created. This value is a UNIX timestamp.

1724505917000
ModifyTimelong

The time when the UDF was last modified. This value is a UNIX timestamp.

1724506661000
Specstring

The FlowSpec field information about the UDF. For more information, see FlowSpec .

Examples

Sample success responses

JSONformat

{
  "RequestId": "6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX",
  "Function": {
    "Id": "860438872620113XXXX\n",
    "ProjectId": "10000",
    "Name": "",
    "Owner": "110755000425XXXX",
    "CreateTime": 1724505917000,
    "ModifyTime": 1724506661000,
    "Spec": ""
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history