规则模板查询接口

最近更新时间:2024-04-16 15:28:16

我的收藏

1. 接口描述

接口请求域名: wedata.tencentcloudapi.com 。

【过滤条件】 {模板名称Name,支持模糊匹配} {模板类型type,1.系统模板 2.自定义模板} {质量检测维度QualityDims, 1.准确性 2.唯一性 3.完整性 4.一致性 5.及时性 6.有效性} 【排序字段】 { 引用数排序类型CitationOrderType,根据引用数量排序 ASC DESC}

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRuleTemplatesByPage。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
PageNumber Integer 当前页
示例值:1
PageSize Integer 每页记录数
示例值:10
ProjectId String 工作空间ID
示例值:1
OrderFields.N Array of OrderField 通用排序字段
Filters.N Array of Filter 通用过滤条件

3. 输出参数

参数名称 类型 描述
Data RuleTemplatePage 结果
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 规则模板列表

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRuleTemplatesByPage
<公共请求参数>

{
    "OrderFields": [
        {
            "Name": "id",
            "Direction": "asc"
        }
    ],
    "Filters": [
        {
            "Name": "tableId",
            "Values": [
                "t678yuh987tgui"
            ]
        }
    ],
    "PageNumber": 1,
    "PageSize": 1,
    "ProjectId": "1"
}

输出示例

{
    "Response": {
        "Data": {
            "TotalCount": 1,
            "Items": [
                {
                    "RuleTemplateId": 1,
                    "Name": "规则1",
                    "Description": "描述",
                    "Type": 1,
                    "SourceObjectType": 1,
                    "SourceObjectDataType": 1,
                    "SourceContent": "content",
                    "SourceEngineTypes": [
                        1
                    ],
                    "QualityDim": 1,
                    "CompareType": 1,
                    "CitationCount": 1,
                    "UserId": 1,
                    "UserName": "zhangsan",
                    "UpdateTime": "2023-10-01",
                    "WhereFlag": true,
                    "MultiSourceFlag": true,
                    "SqlExpression": "sql",
                    "SubQualityDim": 1,
                    "ResolvedSqlExpression": {
                        "TableExpressions": [
                            {
                                "TableExpression": "table1",
                                "ColumnExpression": [
                                    "expr"
                                ]
                            }
                        ],
                        "ParamExpressions": [
                            "expr"
                        ]
                    },
                    "DatasourceTypes": [
                        0
                    ]
                }
            ]
        },
        "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。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter.InvalidFilterParameter 查询过滤条件参数错误。
UnauthorizedOperation.UserNotInProject 用户不是当前项目成员。