1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
保存用户自定义函数
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SaveCustomFunction。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| FunctionId | 是 | String | 函数唯一标识 示例值：c7c17dd8-5348-470f-80dc-61e845624885 |
| Kind | 是 | String | 分类：窗口函数、聚合函数、日期函数...... 示例值：ANALYSIS |
| ClusterIdentifier | 是 | String | 集群引擎实例 示例值：emr-7ih89qvf |
| ClassName | 是 | String | 类名 示例值：com.tencent.tbds.test.hive.udf.Example |
| ResourceList.N | 是 | Array of FunctionResource | 资源列表 示例值：[{"id":null,"type":"cos","path":"cosn://a-jayjyxu-1257305158/function/hiveudf-1.0-SNAPSHOT.jar","md5":"5a0e6f3ce3cdb5d3b51149a08ec2c1b7","name":"hiveudf-1.0-SNAPSHOT.jar"}] |
| Description | 是 | String | 函数说明 示例值：MODIFIED |
| Usage | 是 | String | 用法 示例值：test |
| ParamDesc | 是 | String | 参数说明 示例值：test |
| ReturnDesc | 是 | String | 返回值说明 示例值：test |
| Example | 是 | String | 示例 示例值：wedata |
| ProjectId | 否 | String | 项目id，不支持修改，dlc侧创建函数保存时用 示例值：1485413914375667712 |
| DbName | 否 | String | 数据库名称，不支持修改，dlc侧创建函数保存时用 示例值：wedata |
| Name | 否 | String | 函数名称，不支持修改，dlc侧创建函数保存时用 示例值：wedata |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FunctionId | String | 函数唯一标识 注意：此字段可能返回 null，表示取不到有效值。 示例值：c7c17dd8-5348-470f-80dc-61e845624885 |
| ErrorMessage | String | 无 注意：此字段可能返回 null，表示取不到有效值。 示例值：创建函数失败 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 保存用户自定义函数
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SaveCustomFunction
<公共请求参数>
{
"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"
}输出示例
{
"Response": {
"ErrorMessage": null,
"FunctionId": "d65df5af-28b4-4171-9a24-ce96fc4e83fa",
"RequestId": "ef431542-96ae-467c-b821-f594df8ac83c"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。