API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 数据开发治理平台 WeData > 数据质量相关接口 > 分页查询规则组接口

分页查询规则组接口

最近更新时间：2024-04-16 15:28:27

我的收藏

本页目录：

1. 接口描述

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

【过滤条件】
{表名称TableName,支持模糊匹配} {表负责人TableOwnerName,支持模糊匹配} {监控方式MonitorTypes，1.未配置 2.关联生产调度 3.离线周期检测,支持多选} {订阅人ReceiverUin}
【必要字段】
{数据来源DatasourceId}

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRuleGroupsByPage。
Version 是 String 公共参数，本接口取值：2021-08-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
PageNumber 否 Integer 分页序号
示例值：1
PageSize 否 Integer 分页大小
示例值：50
Filters.N 否 Array of Filter 过滤条件,每次请求的Filters的上限为10，Filter.Values的上限为5
示例值：[ { "Name": "StartTime", "Values": [ "1712160000" ] }, { "Name": "EndTime", "Values": [ "1712764799" ] } ] } ]
OrderFields.N 否 Array of OrderField 排序方式
示例值：[ { "Name": "CitationCount", "Direction": "DESC" } ]
ProjectId 否 String 项目Id
示例值：153161111111111111

3. 输出参数

参数名称 类型 描述
Data RuleGroupPage 规则组列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：{ "Items": [ { "BizCatalogId": null, "BizCatalogName": null, "CreateTime": "2024-03-28 21:25:54", "DatabaseId": "IBw6DFI_pGVj1F73Q", "DatabaseName": "deo_hve_3", "DatasourceId": "968", "DatasourceName": "hive_emr-dbrxq", "DatasourceType": 2, "ExecStrategy": null, "InstanceId": null, "MonitorStatus": null, "MonitorType": null, "Permission": true, "RuleCount": null, "RuleGroupId": null, "StrategyConfiged": false, "SubscribeConfiged": false, "Subscription": null, "TableId": "uEx-slyaR9mod2pr3Zw", "TableName": "mysql_l_read", "TableOwnerName": null, "TableOwnerUserId": 1048673, "UpdateTime": null } ], "TotalCount": 1 }
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 分页查询规则组接口

输入示例

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

{
    "OrderFields": [
        {
            "Direction": "ASC",
            "Name": "id"
        }
    ],
    "PageNumber": 1,
    "Filters": [
        {
            "Values": [
                "78yguhbu78yguh"
            ],
            "Name": "tableId"
        }
    ],
    "PageSize": 1,
    "ProjectId": "1"
}

输出示例

{
    "Response": {
        "Data": {
            "TotalCount": 1,
            "Items": [
                {
                    "RuleGroupId": 1,
                    "DatasourceId": "IBw6DFI_pGVj1F73Q",
                    "DatasourceName": "hive-emr-asda",
                    "DatasourceType": 1,
                    "MonitorType": 1,
                    "UpdateTime": "2022-09-08",
                    "TableName": "table1",
                    "TableId": "IBw6DFI_pGVj1F73Q",
                    "TableOwnerName": "zhangsan",
                    "ExecStrategy": {
                        "RuleGroupId": 1,
                        "MonitorType": 1,
                        "ExecQueue": "default",
                        "ExecutorGroupId": "1",
                        "ExecutorGroupName": "default",
                        "Tasks": [
                            {
                                "WorkflowId": "workflow_dq_1008997",
                                "TaskId": "202403567999922",
                                "TaskName": "shell_test1",
                                "CycleType": 0
                            }
                        ],
                        "StartTime": "2023-09-07 09:09:09",
                        "EndTime": "2023-09-08 09:09:09",
                        "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": [
                            "1"
                        ]
                    },
                    "Subscription": {
                        "RuleGroupId": 1,
                        "Receivers": [
                            {
                                "ReceiverUserId": 1078892223332,
                                "ReceiverName": "zhangsan"
                            }
                        ],
                        "SubscribeType": [
                            1
                        ],
                        "WebHooks": [
                            {
                                "HookType": "feishu",
                                "HookAddress": "http://aassdd.com"
                            }
                        ],
                        "RuleId": 1,
                        "RuleName": "规则名称"
                    },
                    "DatabaseId": "IBw6DFI_pGVj1F73Q",
                    "DatabaseName": "dq_test1",
                    "Permission": true,
                    "RuleCount": 1,
                    "MonitorStatus": true,
                    "TableOwnerUserId": 1,
                    "InstanceId": "emr-asda",
                    "CreateTime": "2022-09-08",
                    "StrategyConfig": true,
                    "SubscribeConfig": true,
                    "DsEnvType": 0
                }
            ]
        },
        "RequestId": "e06e90e7-40e0-4cf4--5566c"
    }
}

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.InvalidFilterParameter 查询过滤条件参数错误。
UnauthorizedOperation.UserNotInProject 用户不是当前项目成员。
中国站