数据开发治理平台 WeData 质量分页查询规则

1. 接口描述

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

分页查询质量规则

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListQualityRules。
Version	是	String	公共参数，本接口取值：2025-08-06。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	是	String	项目ID 示例值：2398577
PageNumber	否	Integer	分页序号，默认1 示例值：1
PageSize	否	Integer	分页大小，默认10 示例值：11
Filters.N	否	Array of Filter	过滤条件，可选过滤条件如下： 1. GroupType 描述：规则组类型，标识规则组所属的分类。取值：DEFAULT - 默认类型，DASHBOARD - 仪表盘类型，WORKFLOW_NODE - 编排空间工作流节点类型 2. Operator 描述：创建人ID。取值：用户ID，支持多个值（OR关系） 3. Keyword 描述：关键字搜索，支持规则名称模糊搜索。取值：字符串 4. RuleName 描述：规则名称。取值：字符串 5. Type 描述：规则类型。取值：1 - 系统模板，2 - 自定义SQL，3 - 自定义模板 6. SourceObjectValue 描述：数据对象，可以是字段名称或表名称。取值：字符串，支持多个值（OR关系） 7. RuleGroupId 描述：规则所属的规则组ID。取值：整数 8. RuleGroupName 描述：规则所属的规则组名称。取值：字符串 9. TableId 描述：数据表ID。取值：字符串，支持多个值（OR关系） 10. TableName 描述：数据表名称。取值：字符串 11. SourceEngineType 描述：数据源引擎类型。取值：整数，1 - MYSQL；2 - HIVE；4 - SPARK；8 - LIVY；16 - DLC；32 - GBASE；64 - TCHouse-P；128 - DORIS；256 - TCHouse-D；512 - EMR_STARROCKS；1024 - TCHouse-X；支持多个值（OR关系） 12. DatasourceId 描述：数据源ID。取值：整数 13. 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 14. DatabaseName 描述：数据库名称。取值：字符串 15. SchemaName 描述：Schema名称。取值：字符串 16. RuleIds 描述：规则ID集合。取值：整数，支持多个值（OR关系） 17. RuleTemplateId 描述：规则模板ID。取值：整数，支持多个值（OR关系） 18. ReceiverUserId / ReceiverUserIdStr 描述：订阅人用户ID。取值：整数 19. StartTime 描述：查询开始时间。取值：Unix时间戳（秒） 20. EndTime 描述：查询结束时间。取值：Unix时间戳（秒） 21. ReceiverFlag 描述：是否为当前登录用户的订阅。取值： true - 是 false - 否 22. MonitorType 描述：规则的监控执行方式。取值：1 - 未配置；2 - 关联生产调度；3 - 离线周期检测；支持多个值（OR关系）支持多个值（OR关系） 23. MonitorStatus 描述：规则的监控状态。取值： true - 已启用 false - 已禁用 24. BizCatalogIds 描述：业务目录ID。取值：整数，支持多个值（OR关系） 25. CatalogName 描述：数据目录名称。取值：字符串 26. DeployStatus 描述：规则部署状态，主要用于WORKFLOW_NODE类型的规则组（监控）上取值：PRODUCTION - 生产环境，DRAFT - 草稿态
OrderFields.N	否	Array of OrderField	通用排序，支持的排序字段： CreateTime - 按创建时间排序 UpdateTime - 按更新时间排序（默认）排序方向： 1 - 升序（ASC） 2 - 降序（DESC）

3. 输出参数

参数名称	类型	描述
Data	QualityRulePage	规则质量列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 分页查询规则

分页查询规则

输入示例

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

{
    "PageNumber": 1,
    "PageSize": 10,
    "ProjectId": "1464962169590902784"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [],
            "TotalCount": 0
        },
        "RequestId": "2b5b3144-1af7-4896-9427-dc92b0254b8b"
    }
}

示例2 分页查询项目下某个数据源下的规则列表

输入示例

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

{
    "ProjectId": "1470547050521227264",
    "PageNumber": 1,
    "PageSize": 1,
    "Filters": [
        {
            "Name": "DatasourceType",
            "Values": [
                "3"
            ]
        },
        {
            "Name": "CatalogName",
            "Values": [
                "DataLakeCatalog"
            ]
        },
        {
            "Name": "DatasourceId",
            "Values": [
                "8860"
            ]
        },
        {
            "Name": "DatabaseName",
            "Values": []
        },
        {
            "Name": "SchemaName",
            "Values": []
        }
    ],
    "OrderFields": []
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "AlarmLevel": 2,
                    "AspectTaskId": "20251231160201243",
                    "CatalogName": "DataLakeCatalog",
                    "CompareRule": {
                        "ComputeExpression": "0",
                        "CycleStep": null,
                        "Items": [
                            {
                                "CompareType": 1,
                                "Operator": "<=",
                                "ValueComputeType": null,
                                "ValueList": [
                                    {
                                        "Value": "10",
                                        "ValueType": 3
                                    }
                                ]
                            }
                        ]
                    },
                    "ConditionExpression": null,
                    "ConditionType": 1,
                    "CreateTime": "2025-12-31 16:02:19",
                    "CustomSql": null,
                    "DatabaseId": null,
                    "DatabaseName": "at_dlc_cloud_gz_prod_mc",
                    "DatasourceId": 8860,
                    "DatasourceName": "dlc_DLC_hx756s1y",
                    "DatasourceType": 3,
                    "Description": "row count",
                    "DsEnvType": 0,
                    "ExecStrategy": {
                        "CycleStep": null,
                        "CycleType": null,
                        "DelayTime": 0,
                        "DlcGroupName": "default-rg-17tv8vfgvy",
                        "EndTime": null,
                        "EngineParam": null,
                        "ExecEngineType": "DLC",
                        "ExecPlan": null,
                        "ExecQueue": "dlc_lina测试勿动",
                        "ExecutorGroupId": "20240222212719833743",
                        "ExecutorGroupName": "qfh_test",
                        "MonitorType": 2,
                        "RuleGroupId": 727,
                        "RuleGroupName": "gee01_202511211444",
                        "RuleId": 1079,
                        "RuleName": "new_rule_5",
                        "ScheduleTimeZone": null,
                        "StartTime": null,
                        "TaskAction": null,
                        "Tasks": [
                            {
                                "InChargeIdList": null,
                                "InChargeNameList": null,
                                "ScheduleTimeZone": null,
                                "TaskId": "20251121143935616",
                                "TaskName": "1121testkkk",
                                "TaskType": "1",
                                "WorkflowId": "49e2197f-957b-43c1-bc8f-162e6ffe9432"
                            }
                        ],
                        "TriggerTypes": [
                            "CYCLE"
                        ]
                    },
                    "FailMsg": null,
                    "FieldConfig": null,
                    "GroupType": "DEFAULT",
                    "MonitorStatus": 1,
                    "MultiSourceFlag": null,
                    "Name": "new_rule_5",
                    "Operator": "wenjieyao",
                    "ProjectId": "1470547050521227264",
                    "ProjectName": "wedata数据开发_新",
                    "QualityDim": 1,
                    "RelConditionExpr": null,
                    "RuleGroupId": 727,
                    "RuleId": 1079,
                    "RuleTemplateContent": "准确性: 表行数",
                    "RuleTemplateId": 6142,
                    "SchemaName": null,
                    "SourceEngineTypes": [
                        2
                    ],
                    "SourceObjectDataType": null,
                    "SourceObjectDataTypeName": "table",
                    "SourceObjectType": 2,
                    "SourceObjectValue": "表",
                    "SubQualityDim": null,
                    "Subscription": null,
                    "TableId": "328",
                    "TableName": "gee01",
                    "TableOwnerName": null,
                    "TargetCatalogName": null,
                    "TargetConditionExpr": null,
                    "TargetDatabaseId": null,
                    "TargetDatabaseName": null,
                    "TargetObjectDataType": null,
                    "TargetObjectDataTypeName": null,
                    "TargetObjectType": null,
                    "TargetObjectValue": null,
                    "TargetSchemaName": null,
                    "TargetTableId": null,
                    "TargetTableName": null,
                    "TemplateSql": null,
                    "TriggerCondition": "固定值 小于等于 10",
                    "Type": 1,
                    "UpdateTime": "2025-12-31 16:02:19",
                    "WhereFlag": null
                }
            ],
            "TotalCount": 12
        },
        "RequestId": "bcb0da72-e4bd-4074-8f06-6ba4da1c10d5"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InvalidParameter.InvalidFilterParameter	查询过滤条件参数错误。
UnauthorizedOperation.UserNotInProject	用户不是当前项目成员。

质量分页查询规则

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 分页查询规则

输入示例

输出示例

示例2 分页查询项目下某个数据源下的规则列表

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码