tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SaveCustomFunction

Last updated: 2024-06-21 15:12:06

1. API Description

Domain name for API request: wedata.tencentcloudapi.com.

Save User-Defined Function

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: SaveCustomFunction.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
FunctionId Yes String Function Unique Identifier
Kind Yes String Classification: Window functions, Aggregation functions, Date functions...
ClusterIdentifier Yes String Cluster Engine Instance
ClassName Yes String Class
ResourceList.N Yes Array of FunctionResource Resource list
Description Yes String Function Description
Usage Yes String Usage
ParamDesc Yes String Parameter description
ReturnDesc Yes String Return value description
Example Yes String Sample code
ProjectId No String Project ID, cannot be modified, used by DLC when saving the function
DbName No String Database Name, cannot be modified, used by DLC when saving the function
Name No String Function Name, cannot be modified, used by DLC when saving the function

3. Output Parameters

Parameter Name Type Description
FunctionId String Function Unique IdentifierNote: This field may return null, indicating that no valid value can be obtained.
ErrorMessage String NoNote: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Save User-Defined Function

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SaveCustomFunction
<Common request parameters>

{
    "Kind": "ANALYSIS",
    "Description": "test",
    "ReturnDesc": "test",
    "ParamDesc": "test",
    "Example": "",
    "ClassName": "com.test.Ad",
    "Usage": "UDFRepeat(var,2)",
    "ResourceList": [
        {
            "Path": "/1219-agent-1ertty559/datastudio/not_del_for_auto/udf-demo-1.0-SNAPSHOT.jar",
            "Id": "b0d9f61f-d15f-4723-8e06-9218b3fd57b3",
            "Type": "cos",
            "Name": "udf-demo-1.0-SNAPSHOT.jar",
            "Md5": ""
        }
    ],
    "ClusterIdentifier": "hive-emr-tegfgd",
    "FunctionId": "d65df5af-28b4-4171-9a24-ce96fc4e83fa"
}

Output Example

{
    "Response": {
        "ErrorMessage": null,
        "FunctionId": "d65df5af-28b4-4171-9a24-ce96fc4e83fa",
        "RequestId": "ef431542-96ae-467c-b821-f594df8ac83c"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy