质量更新规则接口

最近更新时间:2026-01-06 02:55:12

我的收藏

1. 接口描述

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

更新质量规则接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyQualityRule。
Version String 公共参数,本接口取值:2025-08-06。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 项目Id
示例值:280357363890
RuleId Integer 规则ID
示例值:11
Name String 规则名称
示例值:name
Type Integer 规则类型 1.系统模版, 2.自定义模版, 3.自定义SQL
示例值:1
CompareRule QualityCompareRule 报警触发条件
AlarmLevel Integer 报警触发级别 1.低, 2.中, 3.高
示例值:1
TableId String 数据表ID
示例值:23
RuleTemplateId Integer 规则模板ID,当Type≠3(自定义SQL)时必填
示例值:11
QualityDim Integer 规则所属质量维度,Type=3(自定义SQL)时必填(1:准确性,2:唯一性,3:完整性,4:一致性,5:及时性,6:有效性)
示例值:6
RuleGroupId Integer 规则组ID
示例值:1245
SourceObjectDataTypeName String 源字段详细类型,int、string
示例值:int
SourceObjectValue String 源字段名称
示例值:id
ConditionType Integer 检测范围,当Type=1(系统模板)时必填。 1.全表 2.条件扫描
示例值:1
ConditionExpression String 条件扫描WHERE条件表达式,ConditionType=2(条件扫描)时必填
示例值:time='${yyyy-MM-dd}'
CustomSql String 自定义SQL,Type=3(自定义SQL)时必填
示例值:select * from tb1
Description String 规则描述
示例值:检查空
TargetDatabaseId String 目标库Id
示例值:12
TargetTableId String 目标表Id
示例值:21
TargetConditionExpr String 目标过滤条件表达式
示例值:time='${yyyy-MM-dd}'
RelConditionExpr String 源字段与目标字段关联条件on表达式
示例值:id == id
FieldConfig QualityRuleFieldConfig 自定义模版sql表达式字段替换参数,Type=2时必填
TargetObjectValue String 目标字段名称 CITY
示例值:id
SourceEngineTypes.N Array of Integer 该规则支持的执行引擎列表,Type=3(自定义SQL)时必填,可选值如下:1 - MYSQL2 - HIVE4 - SPARK8 - LIVY16 - DLC32 - GBASE64 - TCHouse-P128 - DORIS256 - TCHouse-D512 - EMR_STARROCKS1024 - TCHouse-X
示例值:[1]
TargetDatabaseName String 目标库名
示例值:db2
TargetSchemaName String 目标模式名
示例值:schema1
TargetTableName String 目标表名
示例值:tb1
CatalogName String 数据目录名称,主要用于dlc数据源
示例值:DataLakeCatalog
TargetCatalogName String 目标数据目录名称,主要用于dlc数据源
示例值:DataLakeCatalog

3. 输出参数

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

4. 示例

示例1 修改规则示例

修改规则示例

输入示例

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

{
    "ProjectId": "1464962169590902784",
    "RuleId": 1069,
    "RuleGroupId": 731,
    "Name": "autotest_s3mCmodify",
    "TableId": "E-UEBWQB-XRjERluUg",
    "RuleTemplateId": 54,
    "Type": 1,
    "QualityDim": 1,
    "SourceObjectDataTypeName": "int",
    "SourceObjectValue": "age",
    "ConditionType": 1,
    "ConditionExpression": "pt=substring('${yyyyMMddHHmmss-1H}',1,10)",
    "CompareRule": {
        "Items": [
            {
                "CompareType": 1,
                "Operator": ">",
                "ValueComputeType": 1,
                "ValueList": [
                    {
                        "ValueType": 3,
                        "Value": "0"
                    }
                ]
            }
        ],
        "CycleStep": 1,
        "ComputeExpression": "0"
    },
    "AlarmLevel": 1,
    "Description": "规则",
    "TargetDatabaseId": "97yuhijbkh08y97uhi",
    "TargetTableId": "E-UEBWQB-XRjERluUg",
    "TargetConditionExpr": "ct='${yyyy-mm-dd-1}'",
    "RelConditionExpr": "sourceTable.id=targetTable.id",
    "FieldConfig": {
        "WhereConfig": [
            {
                "FieldKey": "param_1",
                "FieldValue": "id",
                "FieldDataType": "int"
            }
        ],
        "TableConfig": [
            {
                "DatabaseId": "NW0VL_YYPESvi8w",
                "DatabaseName": "default",
                "TableId": "EHdPET2IKQ2KBhGw",
                "TableName": "dq_student",
                "TableKey": "table_1",
                "FieldConfig": [
                    {
                        "FieldKey": "table_1.column_1",
                        "FieldValue": "id",
                        "FieldDataType": "int"
                    }
                ]
            }
        ]
    },
    "TargetObjectValue": "value",
    "SourceEngineTypes": [
        2,
        4
    ]
}

输出示例

{
    "Response": {
        "Data": true,
        "RequestId": "9fd96539-4745-4e36-bf6d-f4b7a6d722a4"
    }
}

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.RuleNotExist 规则不存在。