1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
规则组执行结果分页查询接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListQualityRuleGroupExecResultsByPage。 |
| Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值:29486720 |
| PageNumber | 否 | Integer | 分页序号,默认1 示例值:1 |
| PageSize | 否 | Integer | 分页大小,默认10 示例值:11 |
| Filters.N | 否 | Array of Filter | 过滤条件,支持的过滤条件如下: 1. GroupType 描述:规则组类型,标识规则组所属的分类。 取值:DEFAULT - 默认类型;WORKFLOW_NODE - 编排空间工作流节点类型 2. InstanceId 描述:规则组执行实例ID。 取值:字符串 3. ParentInstanceId 描述:父实例ID。 取值:字符串 4. LifeCycleRunNum 描述:生命周期运行号。 取值:字符串 5. InstanceStatus 描述:实例状态。质量侧的实例状态,一个状态对应调度侧多个状态,具体参考取值说明 取值: 等待运行 - ["INITIAL", "EVENT_LISTENING", "DEPENDENCE", "ALLOCATED", "LAUNCHED", "BEFORE_ASPECT", "ISSUED"]; 运行中 - ["RUNNING", "AFTER_ASPECT", "WAITING_AFTER_ASPECT"] 失败 - ["FAILED", "EXPIRED", "KILL", "KILLING", "PENDING"] 成功 - ["COMPLETED"] 6. DatasourceId 描述:数据源ID。 取值:字符串 7. DatasourceType 描述:数据源类型。 取值:1 - MYSQL;2 - HIVE;3 - DLC;4 - GBASE;5 - TCHouse-P/CDW;6 - ICEBERG;7 - DORIS;8 - TCHouse-D;9 - EMR_STARROCKS;10 - TBDS_STARROCKS;11 - TCHouse-X 8. DatabaseName 描述:数据库名称。 取值:字符串 9. DatabaseId 描述:数据库ID。 取值:字符串 10. SchemaName 描述:Schema名称。 取值:字符串 11. ReceiverFlag 描述:是否为当前登录用户的订阅。 取值:true - 是;false - 否 12. TableName 描述:数据表名称,支持模糊匹配。 取值:字符串 13. RuleGroupName 描述:规则组名称。 取值:字符串 14. RuleGroupExecId 描述:规则组执行ID。 取值:整数 15. RuleGroupTableId 描述:规则组表ID。 取值:整数 16. Keyword 描述:关键字搜索,支持规则组执行Id、表名称、表负责人模糊搜索。如果keyword是纯数字,默认只匹配规则组执行Id。 取值:字符串 17. StartTime 描述:实际运行时间,开始时间。 取值:Unix时间戳(秒) 18. EndTime 描述:实际运行时间,结束时间。 取值:Unix时间戳(秒) 19. ScheduledStartTime 描述:计划调度时间,开始时间。 取值:Unix时间戳(秒) 20. ScheduledEndTime 描述:计划调度时间,结束时间。 取值:Unix时间戳(秒) 21. DsJobId 描述:数据源任务ID。 取值:字符串 22. TriggerType 描述:触发类型。 取值:1 - 手动触发;2 - 调度事中触发;3 - 周期调度触发; 23. Status 描述:规则组执行状态。 取值:0 - 初始状态,未提交;1 - 已提交;2 - 检测中;3 - 正常;4 - 异常;5 - 下发中;6 - 执行链路异常;7 - 未检测,没有执行结果; 24. TableIds 描述:数据表ID集合。 取值:字符串,支持多个值(OR关系) 25. RuleGroupId 描述:规则组ID。 取值:整数 26. BizCatalogIds 描述:业务目录ID。 取值:整数,支持多个值(OR关系) 27. CatalogName 描述:数据目录名称。 取值:字符串 |
| OrderFields.N | 否 | Array of OrderField | 通用排序, 支持的排序字段: CreateTime - 按创建时间排序 UpdateTime - 按更新时间排序(默认) 排序方向: 1 - 升序(ASC) 2 - 降序(DESC) |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | ListQualityRuleGroupExecResultPage | 规则组执行结果列表 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询规则组执行结果
查询规则组执行结果
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListQualityRuleGroupExecResultsByPage
<公共请求参数>
{
"ProjectId": "1470547050521227264",
"PageNumber": 1,
"PageSize": 10,
"Filters": [
{
"Name": "TriggerType",
"Values": []
},
{
"Name": "Status",
"Values": []
},
{
"Name": "StartTime",
"Values": [
"1766592000"
]
},
{
"Name": "EndTime",
"Values": [
"1767196799"
]
},
{
"Name": "InstanceStatus",
"Values": []
},
{
"Name": "DatasourceType",
"Values": [
"3"
]
},
{
"Name": "CatalogName",
"Values": [
"DatalakeCatalog"
]
},
{
"Name": "DatasourceId",
"Values": [
"8860"
]
},
{
"Name": "DatabaseName",
"Values": []
},
{
"Name": "SchemaName",
"Values": []
}
],
"OrderFields": []
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"AlarmRuleCount": 1,
"BizCatalogId": "",
"BizCatalogName": "",
"ClusterDeployType": null,
"DatabaseId": null,
"DatabaseName": "at_dlc_cloud_gz_prod_mc",
"DatasourceId": "8860",
"DsEnvType": 0,
"EngineType": "DLC",
"ExecDetail": "",
"ExecTime": "2025-12-31 17:37:02",
"FailMsg": null,
"FinishTime": "未结束",
"InstanceId": "6820251231173705074_2025-12-31T17:37:04+08:00",
"InstanceStatus": "RUNNING",
"Permission": false,
"ProjectId": "1470547050521227264",
"ProjectName": "wedata数据开发_新",
"RuleExecResultVOList": [
{
"AlarmLevel": 2,
"AspectTaskId": null,
"CatalogName": null,
"CompareResult": {
"ComputeExpression": "0",
"Items": [
{
"CompareType": 1,
"FixResult": null,
"Operator": "<=",
"ResultValue": null,
"ValueComputeType": null,
"Values": [
{
"Value": "10",
"ValueType": 3
}
]
}
],
"PassRows": null,
"TotalRows": null,
"TriggerRows": null
},
"ConditionExpression": "全表 ",
"DatabaseName": null,
"DatasourceId": null,
"DatasourceName": null,
"DatasourceType": null,
"ExecResultStatus": 0,
"FieldConfig": null,
"FinishTime": null,
"GroupType": null,
"MonitorType": null,
"QualityDim": 1,
"RelConditionExpr": null,
"RuleExecId": 383982,
"RuleGroupExecId": 419788,
"RuleGroupExist": null,
"RuleGroupId": 727,
"RuleGroupName": null,
"RuleGroupTableId": null,
"RuleId": 1074,
"RuleName": "new_rule",
"RuleType": 1,
"SchemaName": null,
"SourceObjectDataTypeName": "table",
"SourceObjectValue": "表",
"StartTime": "2025-12-31 17:37:02",
"TableName": null,
"TargetDBTableName": "",
"TargetObjectDataType": null,
"TargetObjectValue": null,
"TemplateName": "表行数",
"TriggerCondition": "固定值 小于等于 10",
"TriggerResult": null
}
],
"RuleGroupExecId": 419788,
"RuleGroupExist": 1,
"RuleGroupId": 727,
"RuleGroupName": "gee01_202511211444",
"RuleGroupTableId": 328,
"StartTime": "2025-12-31 17:37:02",
"Status": 2,
"TableId": "4IVfcrRcAnAV_hbp-NTz8g",
"TableName": "gee01",
"TableOwnerName": null,
"TotalRuleCount": 1,
"TriggerType": 1
}
],
"TotalCount": 1
},
"RequestId": "682d050b-f3f7-4606-8dd3-d63f3261d917"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.InvalidFilterParameter | 查询过滤条件参数错误。 |