分页查询质量规则

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

我的收藏

本页目录：

1. 接口描述

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

分页查询质量规则

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRulesByPage。
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	RulePage	规则质量列表注意：此字段可能返回 null，表示取不到有效值。示例值：[ { "AlarmLevel": 1, "CompareRule": { "ComputeExpression": "0", "CycleStep": null, "Items": [ { "CompareType": 1, "Operator": "\u003c", "ValueComputeType": null, "ValueList": [ { "Value": "1", "ValueType": 3 } ] } ] }, "ConditionExpression": null, "ConditionType": null, "CreateTime": "2024-04-10 17:59:19", "CustomSql": null, "DatabaseId": "sqhsS5G5l43Bm7A", "DatabaseName": "at_hive_bj23", "DatasourceId": 9682, "DatasourceName": "hive_emr-drxq", "Description": null, "ExecStrategy": { "CycleStep": null, "CycleType": null, "DelayTime": null, "EndTime": null, "ExecEngineType": null, "ExecPlan": null, "ExecQueue": null, "ExecutorGroupId": null, "ExecutorGroupName": null, "MonitorType": null, "RuleGroupId": null, "RuleId": null, "RuleName": null, "StartTime": null, "TaskAction": null, "Tasks": null }, "FieldConfig": { "TableConfig": [ { "DatabaseId": "sqhsS5Q8-956Ql43Bm7A", "DatabaseName": "at_hive_bj23", "FieldConfig": [ { "FieldDataType": "string", "FieldKey": "table_1.column_1", "FieldValue": "cid" } ], "TableId": "brNMA9jdQovU49I3x2Q", "TableKey": "table_1", "TableName": "at_dq_0" } ], "WhereConfig": [] }, "MonitorStatus": 0, "MultiSourceFlag": null, "Name": "自定义字段模版", "Operator": "tiezhuzhang", "QualityDim": 3, "RelConditionExpr": null, "RuleGroupId": 1691, "RuleId": 14735, "RuleTemplateContent": "完整性:integrity_col_template", "RuleTemplateId": 13516, "SourceEngineTypes": [ 2 ], "SourceObjectDataType": null, "SourceObjectDataTypeName": null, "SourceObjectType": 3, "SourceObjectValue": null, "SubQualityDim": null, "Subscription": null, "TableId": "brNMA9jdQo69I3x2Q", "TableName": "at_dq_0", "TableOwnerName": "AUTO_TEST", "TargetConditionExpr": null, "TargetDatabaseId": null, "TargetDatabaseName": null, "TargetObjectDataType": null, "TargetObjectDataTypeName": null, "TargetObjectType": null, "TargetObjectValue": null, "TargetTableId": null, "TargetTableName": null, "TemplateSql": null, "TriggerCondition": "固定值小于1", "Type": 2, "WhereFlag": null } ]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 分页查询质量规则

输入示例

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

{
    "PageNumber": 1,
    "PageSize": 1,
    "Filters": [
        {
            "Name": "tableId",
            "Values": [
                "79tugiojbfvdesc"
            ]
        }
    ],
    "OrderFields": [
        {
            "Name": "id",
            "Direction": "asc"
        }
    ],
    "ProjectId": "5346789087654"
}

输出示例

{
    "Response": {
        "Data": {
            "TotalCount": 1,
            "Items": [
                {
                    "RuleId": 1,
                    "RuleGroupId": 1,
                    "TableId": "79tyugihbksda",
                    "Name": "规则",
                    "Type": 1,
                    "RuleTemplateId": 1,
                    "RuleTemplateContent": "cont",
                    "QualityDim": 1,
                    "SourceObjectType": 1,
                    "SourceObjectDataType": 1,
                    "SourceObjectDataTypeName": "string",
                    "SourceObjectValue": "1",
                    "ConditionType": 1,
                    "ConditionExpression": ">",
                    "CustomSql": "abc",
                    "CompareRule": {
                        "Items": [
                            {
                                "CompareType": 1,
                                "Operator": ">",
                                "ValueComputeType": 1,
                                "ValueList": [
                                    {
                                        "ValueType": 1,
                                        "Value": "1"
                                    }
                                ]
                            }
                        ],
                        "CycleStep": 1,
                        "ComputeExpression": "expr"
                    },
                    "AlarmLevel": 1,
                    "Description": "描述",
                    "Operator": "zhangsan",
                    "TargetDatabaseId": "70afsdfaasyighb",
                    "TargetDatabaseName": "dbName",
                    "TargetTableId": "8y9uhojt79u",
                    "TargetTableName": "test",
                    "TargetConditionExpr": "0",
                    "RelConditionExpr": "sourceTable.id = targetTable.id",
                    "FieldConfig": {
                        "WhereConfig": [
                            {
                                "FieldKey": "name",
                                "FieldValue": "zhangsan",
                                "FieldDataType": "string"
                            }
                        ],
                        "TableConfig": [
                            {
                                "DatabaseId": "7p9gyuih78tgy",
                                "DatabaseName": "dbTest",
                                "TableId": "7t8ygihb670ygo",
                                "TableName": "test",
                                "TableKey": "asdfsdf",
                                "FieldConfig": [
                                    {
                                        "FieldKey": "id",
                                        "FieldValue": "12",
                                        "FieldDataType": "int"
                                    }
                                ]
                            }
                        ]
                    },
                    "MultiSourceFlag": true,
                    "WhereFlag": true,
                    "TemplateSql": "select1",
                    "SubQualityDim": 1,
                    "TargetObjectType": 1,
                    "TargetObjectDataType": 1,
                    "TargetObjectDataTypeName": "int",
                    "TargetObjectValue": "1",
                    "SourceEngineTypes": [
                        1
                    ],
                    "TableName": "test",
                    "TableOwnerName": "zhangsan",
                    "ExecStrategy": {
                        "RuleGroupId": 1,
                        "MonitorType": 1,
                        "ExecQueue": "test",
                        "ExecutorGroupId": "6578987685",
                        "ExecutorGroupName": "name",
                        "Tasks": [
                            {
                                "TaskId": "576890867",
                                "TaskName": "任务名",
                                "WorkflowId": "79tyughib87yu9"
                            }
                        ],
                        "StartTime": "2023-10-01",
                        "EndTime": "2023-10-01",
                        "CycleType": "D",
                        "DelayTime": 1,
                        "CycleStep": 1,
                        "TaskAction": "abc",
                        "ExecEngineType": "HIVE",
                        "ExecPlan": "2024-04-07 00:00:00 ~ 2099-12-31 23:59:59，每间隔10分钟执行一次",
                        "RuleId": 1,
                        "RuleName": "规则1"
                    },
                    "Subscription": {
                        "RuleGroupId": 1,
                        "Receivers": [
                            {
                                "ReceiverUserId": 1,
                                "ReceiverName": "zhangsan"
                            }
                        ],
                        "SubscribeType": [
                            1
                        ],
                        "WebHooks": [
                            {
                                "HookType": "1",
                                "HookAddress": "http://www.test.com"
                            }
                        ],
                        "RuleId": 1,
                        "RuleName": "规则1"
                    },
                    "CreateTime": "2023-10-01",
                    "DatasourceId": 1,
                    "DatabaseId": "ssddyhhjj-daskk",
                    "MonitorStatus": 0,
                    "TriggerCondition": "固定值 小于 2"
                }
            ]
        },
        "RequestId": "0ff4e8ab68e69"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

上一篇: 查询质量规则列表下一篇: 查询表质量详情