1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
创建用户自定义函数
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCustomFunction。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Type | 是 | String | 枚举值：HIVE、SPARK、DLC 示例值：HIVE |
| Kind | 是 | String | 枚举值：ANALYSIS(函数)、ENCRYPTION(加密函数)、AGGREGATE(聚合函数)、LOGIC(逻辑函数)、DATE_AND_TIME(日期与时间函数)、MATH(数学函数)、CONVERSION(转换函数)、STRING(字符串函数)、IP_AND_DOMAIN(IP和域名函数)、WINDOW(窗口函数)、OTHER(其他函数) 示例值：ANALYSIS |
| Name | 是 | String | 函数名称 示例值：demoFun |
| ClusterIdentifier | 是 | String | 集群实例引擎 ID 示例值：emr-demo |
| DbName | 否 | String | 数据库名称 示例值：dbName |
| ProjectId | 否 | String | 项目ID 示例值：14854139141111111111111 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FunctionId | String | 函数唯一标识 注意：此字段可能返回 null，表示取不到有效值。 示例值：217377ce-bcc0-446e-afd9-77777777 |
| ErrorMessage | String | 无 注意：此字段可能返回 null，表示取不到有效值。 示例值：errorDemo |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建用户自定义函数
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomFunction
<公共请求参数>
{
"ProjectId": "1470575647377821111",
"Type": "HIVE",
"Kind": "OTHER",
"ClusterIdentifier": "emr-demo",
"DbName": "default",
"Name": "demoFu"
}输出示例
{
"Response": {
"ErrorMessage": null,
"FunctionId": "217377ce-bcc0-446e-afd9-64ef4b707391",
"RequestId": "e5ae06d9-898c-48a6-ae27-ed3758d9ef35"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |