1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询模板详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRuleTemplate。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 否 | String | 项目ID 示例值：153161111111111111 |
| TemplateId | 否 | Integer | 规则模板Id 示例值：2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | RuleTemplate | 模板详情 注意：此字段可能返回 null，表示取不到有效值。 示例值：{ "Items": [ { "CitationCount": 1, "CompareType": 2, "DatasourceTypes": [ 2 ], "Description": "（本周期表行数-上一周期表行数）/上一周期表行数", "MultiSourceFlag": null, "Name": "表行数，上周期波动率", "QualityDim": 1, "ResolvedSqlExpression": null, "RuleTemplateId": 1239, "SourceContent": null, "SourceEngineTypes": [ 2, 4 ], "SourceObjectDataType": 3, "SourceObjectType": 2, "SqlExpression": null, "SubQualityDim": null, "Type": 1, "UpdateTime": null, "UserId": 1, "UserName": null, "Version": null, "WhereFlag": null } ], "TotalCount": 1 } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询模板详情
查询模板详情
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRuleTemplate
<公共请求参数>
{
"ProjectId": "153161111111111111",
"TemplateId": 1
}输出示例
{
"Response": {
"Data": {
"RuleTemplateId": 1,
"Name": "表行数",
"Description": "描述",
"Type": 1,
"SourceObjectType": 1,
"SourceObjectDataType": 1,
"SourceContent": "",
"SourceEngineTypes": [
2
],
"QualityDim": 1,
"CompareType": 1,
"CitationCount": 1,
"UserId": 1,
"UserName": "zahgnsan",
"UpdateTime": "2023-10-01",
"WhereFlag": true,
"MultiSourceFlag": true,
"SqlExpression": "select count(*) from table",
"SubQualityDim": 1,
"ResolvedSqlExpression": {
"TableExpressions": [
{
"TableExpression": "table_2.column_2",
"ColumnExpression": [
"column_1"
]
}
],
"ParamExpressions": [
"param_1"
]
},
"DatasourceTypes": [
2
]
},
"RequestId": "0ff4e8ae-ebea-4a41-8aa2-1f6bc4b68e69"
}
}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 | 操作失败。 |
| InvalidParameter.RuleTemplateNotExist | 规则模版不存在。 |