1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
规则组执行结果分页查询接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRuleGroupExecResultsByPage。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
PageNumber | 否 | Integer | 分页序号 示例值:1 |
PageSize | 否 | Integer | 分页大小 示例值:10 |
Filters.N | 否 | Array of Filter | 过滤条件 示例值:[ { "Name": "StartTime", "Values": [ "1712160000" ] }, { "Name": "EndTime", "Values": [ "1712764799" ] } ] } ] |
OrderFields.N | 否 | Array of OrderField | 排序字段 示例值:[ { "Name": "CitationCount", "Direction": "DESC" } ] |
ProjectId | 否 | String | 项目ID 示例值:153161111111111111 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | RuleGroupExecResultPage | 规则组执行结果列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "Items": [ { "AlarmRuleCount": 1, "BizCatalogId": null, "BizCatalogName": null, "DatabaseId": "sqhsS5G57A", "DatasourceId": "92", "EngineType": "HIVE", "ExecDetail": "2024-04-07 00:00:00 ~ 2099-12-31 23:59:59,每间隔10分钟执行一次", "ExecTime": "2024-04-10 17:01:23", "FailMsg": null, "Permission": true, "RuleExecResultVOList": [ { "AlarmLevel": 3, "CompareResult": { "ComputeExpression": "0", "Items": [ { "CompareType": 1, "FixResult": 1, "Operator": "\u003e", "ResultValue": "2.0000", "ValueComputeType": null, "Values": [ { "Value": "1", "ValueType": 3 } ] } ], "PassRows": null, "TotalRows": null, "TriggerRows": null }, "ConditionExpression": null, "ExecResultStatus": 2, "FieldConfig": null, "QualityDim": 2, "RelConditionExpr": null, "RuleExecId": 3047, "RuleGroupExecId": 1071, "RuleGroupId": 1726, "RuleId": 14723, "RuleName": "文件上传规则", "RuleType": 3, "SourceObjectDataTypeName": "table", "SourceObjectValue": "表", "StartTime": "2024-04-10 17:01:23", "TargetDBTableName": "null.null", "TargetObjectDataType": null, "TargetObjectValue": null, "TemplateName": "用户定义SQL", "TriggerCondition": "固定值大于1", "TriggerResult": "发送告警成功, 阻断任务成功" } ], "RuleGroupExecId": 1057371, "RuleGroupId": 1726, "Status": 4, "TableId": "fr7xvusttwfQ", "TableName": "at_1", "TableOwnerName": "AUEST", "TotalRuleCount": 1, "TriggerType": 3 } ], "TotalCount": 1 } |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 规则组执行结果分页查询接口
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRuleGroupExecResultsByPage
<公共请求参数>
{
"PageNumber": 1,
"PageSize": 1,
"Filters": [
{
"Name": "StartTime",
"Values": [
"1712160000"
]
}
],
"OrderFields": [
{
"Name": "CitationCount",
"Direction": "DESC"
}
],
"ProjectId": "66661616161616161616"
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"AlarmRuleCount": 1,
"DatabaseId": "sqhsS5G57A",
"DatasourceId": "92",
"EngineType": "HIVE",
"ExecDetail": "2024-04-07 00:00:00 ~ 2099-12-31 23:59:59,每间隔10分钟执行一次",
"ExecTime": "2024-04-10 17:01:23",
"Permission": true,
"RuleExecResultVOList": [
{
"AlarmLevel": 3,
"CompareResult": {
"Items": [
{
"CompareType": 1,
"FixResult": 1,
"Operator": ">",
"ResultValue": "2.0000",
"ValueComputeType": null,
"Values": [
{
"Value": "1",
"ValueType": 3
}
]
}
],
"PassRows": null,
"TotalRows": null,
"TriggerRows": null
},
"ConditionExpression": null,
"ExecResultStatus": 2,
"FieldConfig": null,
"QualityDim": 2,
"RelConditionExpr": null,
"RuleExecId": 3047,
"RuleGroupExecId": 1071,
"RuleGroupId": 1726,
"RuleId": 14723,
"RuleName": "文件上传规则",
"RuleType": 3,
"SourceObjectDataTypeName": "table",
"SourceObjectValue": "表",
"StartTime": "2024-04-10 17:01:23",
"TargetDBTableName": "null.null",
"TargetObjectDataType": null,
"TargetObjectValue": null,
"TemplateName": "用户定义SQL",
"TriggerResult": "发送告警成功, 阻断任务成功"
}
],
"RuleGroupExecId": 1057371,
"RuleGroupId": 1726,
"Status": 4,
"TableId": "fr7xvusttwfQ",
"TableName": "at_1",
"TableOwnerName": "AUEST",
"TotalRuleCount": 1,
"TriggerType": 3
}
],
"TotalCount": 1
},
"RequestId": "15bb9da3584b"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameter.InvalidFilterParameter | 查询过滤条件参数错误。 |