1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询全量函数
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOrganizationalFunctions。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Type | 是 | String | 场景类型：开发、使用 示例值：FUNC_DEVELOP、USE_SPACE |
| ProjectId | 是 | String | 项目 ID 示例值：1460947878944567296 |
| Name | 否 | String | 函数名称 示例值：wedata |
| DisplayName | 否 | String | 展示名称 示例值：fenxi |
| EnvType | 否 | String | 标准模式开发环境：DEV 标准模式生产环境：PROD 简单模式：ALL 示例值：dev |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Content | Array of OrganizationalFunction | 函数信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "Category": "CUSTOM", "Status": "EFFECTIVE", "Kind": "ANALYSIS", "DisplayName": "Hive SQL 函数", "Name": "hive_01", "OwnerUserIds": [ 0 ], "ReturnDesc": "test", "FuncId": "d65df5af-28b4-4171-9a24-ce96fc4e83fa", "ParamDesc": "test", "Example": "", "ClassName": "demoClass", "ResourceList": [ { "Comment": "test", "UserName": "test", "Timestamp": "20240101", "UserId": "4563234", "Content": "test", "Tag": "tag", "Type": "HIVE" } ], "OperatorUserIds": [ 0 ], "Usage": "UDFRepeat(var,2)", "ClusterIdentifier": "fpgreitj", "LayerPath": "/HIVE/CUSTOM", "Type": "HIVE", "SubmitErrorMsg": "test", "SchemaName": "cdw", "CommandFormat": "cdw", "DbName": "test", "ParentLayerPath": "/HIVE", "Description": "test" } ] |
| 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: DescribeOrganizationalFunctions
<公共请求参数>
{
"ProjectId": "1531609696090365952",
"Type": "FUNC_DEVELOP",
"Name": "test",
"DisplayName": "test"
}输出示例
{
"Response": {
"Content": [
{
"Category": "CUSTOM",
"Status": "EFFECTIVE",
"Kind": "ANALYSIS",
"DisplayName": "Hive SQL 函数",
"Name": "hive_01",
"OwnerUserIds": [
0
],
"ReturnDesc": "test",
"FuncId": "d65df5af-28b4-4171-9a24-ce96fc4e83fa",
"ParamDesc": "test",
"Example": "",
"ClassName": "demoClass",
"ResourceList": [
{
"Comment": "test",
"UserName": "test",
"Timestamp": "20240101",
"UserId": "4563234",
"Content": "test",
"Tag": "tag",
"Type": "HIVE"
}
],
"OperatorUserIds": [
0
],
"Usage": "UDFRepeat(var,2)",
"ClusterIdentifier": "fpgreitj",
"LayerPath": "/HIVE/CUSTOM",
"Type": "HIVE",
"SubmitErrorMsg": "test",
"SchemaName": "cdw",
"CommandFormat": "cdw",
"DbName": "test",
"ParentLayerPath": "/HIVE",
"Description": "test"
}
],
"ErrorMessage": null,
"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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |