创建质量规则接口

1. 接口描述

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

创建质量规则接口

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 创建质量规则接口

创建质量规则组中单个规则

输入示例

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

{
    "ProjectId": "11114192353510111488",
    "RuleGroupId": 1,
    "Name": "autotest_s3mC",
    "TableId": "E-UEBWQB-XRjERluUg",
    "RuleTemplateId": 1,
    "Type": 1,
    "QualityDim": 1,
    "SourceObjectDataTypeName": "int",
    "SourceObjectValue": "age",
    "ConditionType": 1,
    "ConditionExpression": "pt=substring('${yyyyMMddHHmmss-1H}',1,10)",
    "CustomSql": "SELECT id,name FROM `at_hive_bj`.`at_hive_22`;",
    "CompareRule": {
        "Items": [
            {
                "CompareType": 1,
                "Operator": ">",
                "ValueComputeType": 1,
                "ValueList": [
                    {
                        "ValueType": 3,
                        "Value": "0"
                    }
                ]
            }
        ],
        "CycleStep": 1,
        "ComputeExpression": "0"
    },
    "AlarmLevel": 1,
    "Description": "测试",
    "DatasourceId": "678990",
    "DatabaseId": "97yuhijbkh08y97uhi",
    "TargetDatabaseId": "97yuhijbkh08y97uhi",
    "TargetTableId": "E-UEBWQB-XRjERluUg",
    "TargetConditionExpr": "ct='${yyyy-mm-dd-1}'",
    "RelConditionExpr": "sourceTable.id=targetTable.id",
    "FieldConfig": {
        "TableConfig": [
            {
                "DatabaseId": "NW0VL_YYPESvi8w",
                "DatabaseName": "default",
                "TableId": "EHdPET2IKQ2KBhGw",
                "TableName": "dq_student",
                "TableKey": "table_1",
                "FieldConfig": [
                    {
                        "FieldKey": "table_1.column_1",
                        "FieldDataType": "int",
                        "FieldValue": "id"
                    }
                ]
            }
        ],
        "WhereConfig": [
            {
                "FieldKey": "param_1",
                "FieldDataType": "int",
                "FieldValue": "id"
            }
        ]
    },
    "TargetObjectValue": "value",
    "SourceEngineTypes": [
        2,
        4
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "RuleId": 1,
            "RuleGroupId": 1,
            "TableId": "E-UEBWsQB-XRjERluUg",
            "TableName": "dq",
            "DatabaseId": "roeqgaBtT4m22RyjnMQ",
            "DatasourceId": 6789789,
            "Name": "测试",
            "Type": 1,
            "RuleTemplateId": 1,
            "RuleTemplateContent": "描述",
            "QualityDim": 1,
            "SourceObjectType": 1,
            "SourceObjectDataType": 1,
            "SourceObjectDataTypeName": "int",
            "SourceObjectValue": "age",
            "ConditionType": 1,
            "ConditionExpression": "pt=substring('${yyyyMMddHHmmss-1H}',1,10)",
            "CustomSql": "SELECT id,name FROM `at_hive_bj`.`at_hive_22`;",
            "CreateTime": "2024-02-22 21:49:55",
            "TableOwnerName": "AUTO_TEST",
            "SourceEngineTypes": [
                2,
                4,
                16
            ],
            "ExecStrategy": {
                "CycleStep": null,
                "CycleType": null,
                "DelayTime": null,
                "EndTime": null,
                "ExecEngineType": null,
                "ExecPlan": null,
                "ExecQueue": null,
                "ExecutorGroupId": null,
                "ExecutorGroupName": null,
                "MonitorType": 2,
                "RuleGroupId": null,
                "RuleId": 1263,
                "RuleName": "field_minimum_trigger_fail",
                "StartTime": null,
                "TaskAction": null,
                "Tasks": [
                    {
                        "TaskId": "20240205135835",
                        "TaskName": "at_qualire_task_1708606293AquG",
                        "WorkflowId": "1c2a85c6-d181-11eeb-b8cef68a6637"
                    }
                ]
            },
            "Subscription": {
                "Receivers": [
                    {
                        "ReceiverName": "yukzhang",
                        "ReceiverUserId": 100581064
                    }
                ],
                "RuleGroupId": null,
                "RuleId": 125,
                "RuleName": null,
                "SubscribeType": [
                    1
                ],
                "WebHooks": []
            },
            "CompareRule": {
                "Items": [
                    {
                        "CompareType": 1,
                        "Operator": ">",
                        "ValueComputeType": 1,
                        "ValueList": [
                            {
                                "ValueType": 3,
                                "Value": "0"
                            }
                        ]
                    }
                ],
                "CycleStep": 1
            },
            "AlarmLevel": 2,
            "Description": "测试",
            "Operator": "zhangsan",
            "TargetDatabaseId": "6788897uigygh967q23e",
            "TargetDatabaseName": "test",
            "TargetTableId": "y8o97hufe378qygfvbqd",
            "TargetTableName": "dq",
            "TargetConditionExpr": "ct='${yyyy-mm-dd-1}'",
            "RelConditionExpr": "sourceTable.id=targetTable.id",
            "FieldConfig": {
                "TableConfig": [
                    {
                        "DatabaseId": "NW0VL_YYPESvi8w",
                        "DatabaseName": "default",
                        "TableId": "EHdPET2IKQ2KBhGw",
                        "TableName": "dq_student",
                        "TableKey": "table_1",
                        "FieldConfig": [
                            {
                                "FieldKey": "table_1.column_1",
                                "FieldDataType": "int",
                                "FieldValue": "id"
                            }
                        ]
                    }
                ],
                "WhereConfig": [
                    {
                        "FieldKey": "param_1",
                        "FieldDataType": "int",
                        "FieldValue": "id"
                    }
                ]
            },
            "MultiSourceFlag": true,
            "WhereFlag": true,
            "TemplateSql": "select count(${table_1.column_1}) from ${table_1}",
            "SubQualityDim": 1,
            "TargetObjectType": 1,
            "TargetObjectDataType": 1,
            "TargetObjectDataTypeName": "name",
            "TargetObjectValue": "value"
        },
        "RequestId": "e447b6ad-c3c3-44b5-b473-dbfc39591f93"
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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