质量创建监控任务

最近更新时间:2026-01-06 02:55:14

我的收藏

1. 接口描述

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

创建监控任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateQualityRuleGroup。
Version String 公共参数,本接口取值:2025-08-06。
Region String 公共参数,详见产品支持的 地域列表
RuleGroupExecStrategyBOList.N Array of QualityRuleGroupExecStrategy 任务参数
ProjectId String 项目ID
示例值:89765

3. 输出参数

参数名称 类型 描述
Data CreateQualityRuleGroupResultVO 是否更新成功
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建dlc表的质量监控任务

输入示例

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

{
    "RuleGroupExecStrategyBOList": [
        {
            "MonitorType": 3,
            "RuleGroupName": "dlc_test_rule_group_1",
            "DatabaseName": "at_dlc_cloud_gz_prod",
            "DatasourceId": "8860",
            "ExecQueue": "dlc_lina测试勿动",
            "ExecutorGroupId": "20240222212719833743",
            "ExecutorGroupName": "qfh_test",
            "StartTime": "2025-12-31 00:00:00",
            "EndTime": "2025-12-31 23:59:59",
            "CycleType": "D",
            "DelayTime": 0,
            "CycleStep": 1,
            "TaskAction": "",
            "ExecEngineType": "DLC",
            "DlcGroupName": "default-rg-17tv8vfgvy",
            "SchemaName": "",
            "TableName": "at_src_mysql_bigint_unsigned_t1",
            "Description": "测试创建dlc表的规则组",
            "ScheduleTimeZone": "UTC+5",
            "CatalogName": "DataLakeCatalog"
        }
    ],
    "ProjectId": "1470547050521227264"
}

输出示例

{
    "Response": {
        "Data": {
            "RuleGroupResultList": [
                {
                    "CatalogName": "DataLakeCatalog",
                    "DatabaseName": "at_dlc_cloud_gz_prod",
                    "DatasourceId": "8860",
                    "ExecDetail": null,
                    "FailMsg": "Creation failed, please contact technical support for problem diagnosis",
                    "Id": null,
                    "MonitorType": 3,
                    "Name": "dlc_test_rule_group_1",
                    "RuleGroupTableId": null,
                    "SchemaName": "",
                    "TableName": "at_src_mysql_bigint_unsigned_t1"
                }
            ]
        },
        "RequestId": "c6c361e9-fde9-4ee5-bdcd-56952e21d893"
    }
}

示例2 创建规则组

创建规则组

输入示例

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

{
    "RuleGroupExecStrategyBOList": [
        {
            "MonitorType": 3,
            "RuleGroupName": "mico_iceberg_table_202504181829",
            "DatabaseName": "default",
            "DatasourceId": "61949",
            "ExecQueue": "default",
            "ExecutorGroupId": "7645325746524236",
            "ExecutorGroupName": "test_worker",
            "StartTime": "2025-04-18 00:00:00",
            "EndTime": "2025-04-18 23:59:59",
            "CycleType": "I",
            "DelayTime": 0,
            "CycleStep": 10,
            "TaskAction": "",
            "ExecEngineType": "SPARK",
            "SchemaName": "",
            "TableName": "mico_iceberg_table"
        }
    ],
    "ProjectId": "1464962169590902784"
}

输出示例

{
    "Response": {
        "Data": {
            "RuleGroupResultList": [
                {
                    "CatalogName": null,
                    "DatabaseName": "default",
                    "DatasourceId": "61949",
                    "ExecDetail": null,
                    "FailMsg": "Parameter validation failed.:Data table does not exist.",
                    "Id": null,
                    "MonitorType": 3,
                    "Name": "mico_iceberg_table_202504181829",
                    "RuleGroupTableId": null,
                    "SchemaName": "",
                    "TableName": "mico_iceberg_table"
                }
            ]
        },
        "RequestId": "4d4a61d7-edd7-4590-b296-929e73b5ed20"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码