数据开发治理平台 WeData 质量创建规则接口

1. 接口描述

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

创建质量规则接口

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateQualityRule。
Version	是	String	公共参数，本接口取值：2025-08-06。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	是	String	项目id 示例值：18965
CreateRuleScene	是	Integer	规则创建场景 1：单表多规则 2：多表单规则 3：克隆创建规则示例值：1
RuleBOList.N	是	Array of QualityRuleInfo	单条规则信息集合

3. 输出参数

参数名称	类型	描述
Data	CreateQualityRuleVO	规则创建结果注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建质量检测规则

输入示例

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

{
    "ProjectId": "1470547050521227264",
    "CreateRuleScene": 1,
    "RuleBOList": [
        {
            "Name": "new_rule_5",
            "Type": 1,
            "RuleGroupId": 727,
            "RuleTemplateId": 6142,
            "SourceObjectDataTypeName": "table",
            "SourceObjectValue": "表",
            "ConditionType": 1,
            "CompareRule": {
                "Items": [
                    {
                        "CompareType": 1,
                        "Operator": "<=",
                        "ValueList": [
                            {
                                "ValueType": 3,
                                "Value": "10"
                            }
                        ]
                    }
                ],
                "ComputeExpression": "0"
            },
            "AlarmLevel": 2,
            "Description": "row count",
            "DatasourceId": "8860",
            "SourceEngineTypes": [
                16
            ],
            "Index": "50464ee-6775-7037-4e0a-c02ae7baf8d",
            "DatabaseName": "at_dlc_cloud_gz_prod_mc",
            "TableName": "gee01",
            "CatalogName": "DataLakeCatalog"
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "FailedCount": 0,
            "Msg": "共配置1条规则，其中1条生成成功，0条生成失败",
            "Results": [
                {
                    "Msg": null,
                    "Name": "new_rule_5",
                    "RuleGroupId": 727,
                    "RuleGroupTableId": 328,
                    "RuleId": 1079,
                    "Success": true
                }
            ],
            "SuccessCount": 1,
            "SuccessRuleIds": [
                1079
            ],
            "SumCount": 1
        },
        "RequestId": "e8cda1dc-d78f-419a-8653-8295a5e1eb0d"
    }
}

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: 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	操作失败。
InvalidParameter.DuplicateName	名称重复。
InvalidParameter.ServiceIsBusy	服务繁忙，请稍后重试。

质量创建规则接口

本页目录：