有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

查询规则详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRule。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
RuleId Integer 质量规则ID
示例值:123456
ProjectId String 项目ID
示例值:123456

3. 输出参数

参数名称 类型 描述
Data Rule 规则详情
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "AlarmLevel": 2, "CompareRule": { "ComputeExpression": "0", "CycleStep": 1, "Items": [ { "CompareType": 1, "Operator": "\u003e", "ValueComputeType": 1, "ValueList": [ { "Value": "10", "ValueType": 3 } ] } ] }, "ConditionExpression": "pt=substring('${yyyyMMddHHmmss-1H}',1,10)", "ConditionType": 1, "CreateTime": "2024-02-22 21:49:55", "CustomSql": "SELECT id,name FROM at_hive_bj.at_hive_22;", "DatabaseId": "roeqgaBtT4m22RyjnMQ", "DatasourceId": "678990", "Description": null, "ExecStrategy": { "CycleStep": 10, "CycleType": "I", "DelayTime": 0, "EndTime": "2099-12-31 23:59:59", "ExecEngineType": "HIVE", "ExecPlan": "2024-03-07 00:00:00 ~ 2099-12-31 23:59:59,每间隔10分钟执行一次", "ExecQueue": "default", "ExecutorGroupId": "20240307193015743960", "ExecutorGroupName": "wedata-test-use-sch-sh", "MonitorType": 3, "RuleGroupId": null, "RuleId": 1293, "RuleName": "表记录数小于10", "StartTime": "2024-03-07 00:00:00", "TaskAction": "", "Tasks": [ { "TaskId": "20240205135835", "TaskName": "at_qualire_task_1708606293AquG", "WorkflowId": "1c2a85c6-d181-11eeb-b8cef68a6637" } ] }, "FieldConfig": null, "MonitorStatus": 0, "MultiSourceFlag": false, "Name": "表记录数小于10", "Operator": "dylandlwu", "QualityDim": 1, "RelConditionExpr": "sourceTable.id=targetTable.id", "RuleGroupId": 371, "RuleId": 1293, "RuleTemplateContent": "准确性: 表行数", "RuleTemplateId": 1, "SourceEngineTypes": [ 2, 4, 16 ], "SourceObjectDataType": 3, "SourceObjectDataTypeName": "table", "SourceObjectType": 2, "SourceObjectValue": "表", "SubQualityDim": 0, "Subscription": { "Receivers": [ { "ReceiverName": "solondeng", "ReceiverOwnerUserId": null, "ReceiverUserId": 100596846 } ], "RuleGroupId": null, "RuleId": 1293, "RuleName": null, "SubscribeType": [ 1, 2, 5 ], "WebHooks": [ { "HookAddress": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=2477c-5a80-43f7-bb6b-6c606420e", "HookType": "qywx" } ] }, "TableId": "O34kNIp-70pmT10q4vQ", "TableName": null, "TableOwnerName": null, "TargetConditionExpr": null, "TargetDatabaseId": null, "TargetDatabaseName": null, "TargetObjectDataType": null, "TargetObjectDataTypeName": null, "TargetObjectType": null, "TargetObjectValue": null, "TargetTableId": null, "TargetTableName": null, "TemplateSql": null, "TriggerCondition": "固定值大于10", "Type": 1, "WhereFlag": false }
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询规则详情

输入示例

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

{
    "ProjectId": "153160990365952",
    "RuleId": 1
}

输出示例

{
    "Response": {
        "Data": {
            "AlarmLevel": 2,
            "CompareRule": {
                "ComputeExpression": "0",
                "CycleStep": 1,
                "Items": [
                    {
                        "CompareType": 1,
                        "Operator": ">",
                        "ValueComputeType": 1,
                        "ValueList": [
                            {
                                "Value": "10",
                                "ValueType": 3
                            }
                        ]
                    }
                ]
            },
            "ConditionExpression": "pt=substring('${yyyyMMddHHmmss-1H}',1,10)",
            "ConditionType": 1,
            "CreateTime": "2024-02-22 21:49:55",
            "CustomSql": "SELECT id,name FROM `at_hive_bj`.`at_hive_22`;",
            "DatabaseId": "roeqgaBtT4m22RyjnMQ",
            "DatasourceId": "678990",
            "Description": null,
            "ExecStrategy": {
                "CycleStep": 10,
                "CycleType": "I",
                "DelayTime": 0,
                "EndTime": "2099-12-31 23:59:59",
                "ExecEngineType": "HIVE",
                "ExecPlan": "2024-03-07 00:00:00 ~ 2099-12-31 23:59:59,每间隔10分钟执行一次",
                "ExecQueue": "default",
                "ExecutorGroupId": "20240307193015743960",
                "ExecutorGroupName": "wedata-test-use-sch-sh",
                "MonitorType": 3,
                "RuleGroupId": null,
                "RuleId": 1293,
                "RuleName": "表记录数小于10",
                "StartTime": "2024-03-07 00:00:00",
                "TaskAction": "",
                "Tasks": [
                    {
                        "TaskId": "20240205135835",
                        "TaskName": "at_qualire_task_1708606293AquG",
                        "WorkflowId": "1c2a85c6-d181-11eeb-b8cef68a6637"
                    }
                ]
            },
            "FieldConfig": null,
            "MonitorStatus": 0,
            "MultiSourceFlag": false,
            "Name": "表记录数小于10",
            "Operator": "dylandlwu",
            "QualityDim": 1,
            "RelConditionExpr": "sourceTable.id=targetTable.id",
            "RuleGroupId": 371,
            "RuleId": 1293,
            "RuleTemplateContent": "准确性: 表行数",
            "RuleTemplateId": 1,
            "SourceEngineTypes": [
                2,
                4,
                16
            ],
            "SourceObjectDataType": 3,
            "SourceObjectDataTypeName": "table",
            "SourceObjectType": 2,
            "SourceObjectValue": "表",
            "SubQualityDim": 0,
            "Subscription": {
                "Receivers": [
                    {
                        "ReceiverName": "solondeng",
                        "ReceiverUserId": 100596846
                    }
                ],
                "RuleGroupId": null,
                "RuleId": 1293,
                "RuleName": null,
                "SubscribeType": [
                    1,
                    2,
                    5
                ],
                "WebHooks": [
                    {
                        "HookAddress": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=2477c-5a80-43f7-bb6b-6c606420e",
                        "HookType": "qywx"
                    }
                ]
            },
            "TableId": "O34kNIp-70pmT10q4vQ",
            "TableName": null,
            "TableOwnerName": null,
            "TargetConditionExpr": null,
            "TargetDatabaseId": null,
            "TargetDatabaseName": null,
            "TargetObjectDataType": null,
            "TargetObjectDataTypeName": null,
            "TargetObjectType": null,
            "TargetObjectValue": null,
            "TargetTableId": null,
            "TargetTableName": null,
            "TemplateSql": null,
            "TriggerCondition": "固定值大于10",
            "Type": 1,
            "WhereFlag": false
        },
        "RequestId": "b50caa8f-0c3a-45b3--64948ae52b0c"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.RuleNotExist 规则不存在。