查询质量规则列表

1. 接口描述

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

查询质量规则列表

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询质量规则列表

{
"ProjectId": "abc",
"RuleGroupId": 1,
"EngineType":"HIVE"
}

输入示例

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

{
    "ProjectId": "153161111111111111",
    "RuleGroupId": 1,
    "EngineType": "HIVE"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "RuleId": 1,
                "RuleGroupId": 1,
                "TableId": "79tyugihbksda",
                "Name": "规则",
                "Type": 1,
                "RuleTemplateId": 1,
                "RuleTemplateContent": "准确性：表行数",
                "QualityDim": 1,
                "SourceObjectType": 1,
                "SourceObjectDataType": 1,
                "SourceObjectDataTypeName": "string",
                "SourceObjectValue": "1",
                "ConditionType": 1,
                "ConditionExpression": ">",
                "CustomSql": "abc",
                "CompareRule": {
                    "Items": [
                        {
                            "CompareType": 1,
                            "Operator": ">",
                            "ValueComputeType": 1,
                            "ValueList": [
                                {
                                    "ValueType": 1,
                                    "Value": "1"
                                }
                            ]
                        }
                    ],
                    "CycleStep": 1,
                    "ComputeExpression": "0"
                },
                "AlarmLevel": 1,
                "Description": "描述",
                "Operator": "zhangsan",
                "TargetDatabaseId": "easdsad-dasdas",
                "TargetDatabaseName": "db1",
                "TargetTableId": "dsadxc-dsada",
                "TargetTableName": "table1",
                "TargetConditionExpr": "0",
                "RelConditionExpr": "sourceTable.id = targetTable.id",
                "FieldConfig": {
                    "WhereConfig": [
                        {
                            "FieldKey": "name",
                            "FieldValue": "zhangsan",
                            "FieldDataType": "string"
                        }
                    ],
                    "TableConfig": [
                        {
                            "DatabaseId": "7p9gyuih78tgy",
                            "DatabaseName": "dbTest",
                            "TableId": "7t8ygihb670ygo",
                            "TableName": "test",
                            "TableKey": "asdfsdf",
                            "FieldConfig": [
                                {
                                    "FieldKey": "id",
                                    "FieldValue": "12",
                                    "FieldDataType": "int"
                                }
                            ]
                        }
                    ]
                },
                "MultiSourceFlag": true,
                "WhereFlag": true,
                "TemplateSql": "select count(*) from a",
                "SubQualityDim": 1,
                "TargetObjectType": 1,
                "TargetObjectDataType": 1,
                "TargetObjectDataTypeName": "int",
                "TargetObjectValue": "1",
                "SourceEngineTypes": [
                    2
                ],
                "TableName": "abc",
                "TableOwnerName": "abc",
                "ExecStrategy": {
                    "RuleGroupId": 1,
                    "MonitorType": 1,
                    "ExecQueue": "default",
                    "ExecutorGroupId": "2",
                    "ExecutorGroupName": "资源组",
                    "Tasks": [
                        {
                            "WorkflowId": "32131232323",
                            "TaskId": "321321321321",
                            "TaskName": "shell1",
                            "CycleType": 1
                        }
                    ],
                    "StartTime": "2023-10-01",
                    "EndTime": "2023-10-01",
                    "CycleType": "D",
                    "DelayTime": 1,
                    "CycleStep": 1,
                    "TaskAction": "",
                    "ExecEngineType": "HIVE",
                    "ExecPlan": "2024-04-07 00:00:00 ~ 2099-12-31 23:59:59，每间隔10分钟执行一次",
                    "RuleId": 1,
                    "RuleName": "规则",
                    "TriggerTypes": [
                        "2"
                    ]
                },
                "Subscription": {
                    "RuleGroupId": 1,
                    "Receivers": [
                        {
                            "ReceiverUserId": 1,
                            "ReceiverName": "zhangsan"
                        }
                    ],
                    "SubscribeType": [
                        1
                    ],
                    "WebHooks": [
                        {
                            "HookType": "1",
                            "HookAddress": "http://www.test.com"
                        }
                    ],
                    "RuleId": 1,
                    "RuleName": "规则1"
                },
                "CreateTime": "2023-10-01",
                "DatasourceId": 1,
                "DatabaseId": "sddyhhjj-daskk",
                "MonitorStatus": 0,
                "TriggerCondition": "固定值 小于 2"
            }
        ],
        "RequestId": "0ff4e8ab68e69"
    }
}

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. 错误码

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