数据开发治理平台 WeData 规则模板

接口请求域名: wedata.tencentcloudapi.com 。推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。可以查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

相关产品
数据开发治理平台 WeData 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

创建规则模板

默认接口请求频率限制:20次/秒。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateRuleTemplate。
Version 是 String 公共参数,本接口取值:2021-08-20。
Region 是 String 公共参数,详见产品支持的 地域列表。
Type 否 Integer 模版类型:1-系统模版,2-用户自定义模版示例值:1
Name 否 String 模板名称示例值:规则模版
QualityDim 否 Integer 质量维度:1-准确性,2-唯一性,3-完整性,4-一致性,5-及时性,6-有效性示例值:1
SourceObjectType 否 Integer 源数据对象类型:1-常量,2-离线表级,3-离线字段级别示例值:123456
Description 否 String 模板描述示例值:描述11
SourceEngineTypes.N 否 Array of Integer 执行引擎多选(位运算数组):2-HIVE,4-SPARK,8-LIVY,16-DLC,64-TCHouse-P,128-DORIS,256-TCHouse-D,512-EMR-StarRocks,1024-TCHouse-X示例值:[ 2 ]
MultiSourceFlag 否 Boolean 是否关联其它库表示例值:true
SqlExpression 否 String SQL 表达式示例值:c2VsZWN0IGNvdW50KCR7dGFibGVfY29sdW1uXzJ9ID0gJHt0YWJsZV9jb2x1bW5fMn0=
ProjectId 否 String 项目Id示例值:19830324
WhereFlag 否 Boolean 是否添加where参数示例值:true

三、3. 输出参数

参数名称 类型 描述
Data Integer 模板Id注意:此字段可能返回 null,表示取不到有效值。示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、示例1 创建规则模板

创建规则模板

五、输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRuleTemplate
<公共请求参数>
{
"Description": "auto test description",
"MultiSourceFlag": true,
"Name": "auto_test_template_query_cust",
"ProjectId": "153160990365952",
"QualityDim": 1,
"SourceEngineTypes": [
2
],
"SourceObjectType": 2,
"SqlExpression": "c2VsZWN0IGNvdW50KCR7dGFibGVfY29sdW1uXzJ9ID0gJHt0YWJsZV9jb2x1bW5fMn0=",
"Type": 2,
"WhereFlag": true
}

六、输出示例

{
"Response": {
"Data": 1,
"RequestId": "0ff4e8ae-ebea-8aa2-1f6bc4b68e69"
}
}

七、腾讯云 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: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

十、命令行工具

·Tencent Cloud CLI 3.0

十一、6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
赞 (0)
上一篇 4天前
下一篇 4天前