1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
【过滤条件】
{表idTableId,支持匹配} {任务负责人Operator,支持匹配}
【必要字段】
{数据来源TableId}
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListQualityRuleGroups。 |
| Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目Id 示例值:1470547050521227264 |
| PageNumber | 否 | Integer | 分页序号,默认1 示例值:1 |
| PageSize | 否 | Integer | 分页大小,默认10 示例值:10 |
| Filters.N | 否 | Array of Filter | 过滤条件,每次请求的Filters的上限为10,Filter.Values的上限为5,可选过滤条件如下: 1. RuleGroupId 描述:规则组ID。 取值:整数 2. RuleGroupName 描述:规则组名称。 取值:字符串 3. TableId 描述:数据源表id 取值:字符串 4. TableName 描述:数据源表名称,支持模糊匹配。 取值:字符串 5. TableOwnerName 描述:表负责人名称,支持模糊匹配。 取值:字符串 6. 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 7. DatasourceId 描述:数据源ID。 取值:字符串 8. DatabaseName 描述:数据库名称。 取值:字符串 9. SchemaName 描述:Schema名称。 取值:字符串 10. CatalogName 描述:数据目录名称。 取值:字符串 |
| OrderFields.N | 否 | Array of OrderField | 通用排序,支持的排序字段: CreateTime - 按创建时间排序 UpdateTime - 按更新时间排序(默认) 排序方向: 1 - 升序(ASC) 2 - 降序(DESC) |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | QualityRuleGroupPage | 任务列表 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询质量监控列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListQualityRuleGroups
<公共请求参数>
{
"ProjectId": "1470547050521227264",
"Filters": [
{
"Name": "RuleGroupId",
"Values": [
"743"
]
}
]
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"AspectTaskId": "20260105170922315",
"CatalogName": "DataLakeCatalog",
"ClusterDeployType": null,
"CreateTime": "2026-01-05 16:33:34",
"CreateUserName": "wenjieyao",
"DatabaseId": null,
"DatabaseName": "at_dlc_cloud_gz_prod_mc",
"DatasourceId": "8860",
"DatasourceName": "dlc_DLC_hx756s1y",
"DatasourceType": 3,
"Description": "create ruleGroup",
"EnableRuleCount": 1,
"ExecDetail": "20250826201812341",
"ExecStrategy": {
"CycleStep": 12,
"CycleType": "H",
"DelayTime": 0,
"DlcGroupName": "default-rg-17tv8vfgvy",
"EndTime": "2026-01-10 23:59:59",
"EngineParam": null,
"ExecEngineType": "DLC",
"ExecPlan": null,
"ExecQueue": "dlc_lina测试勿动",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"MonitorType": 2,
"RuleGroupId": 743,
"RuleGroupName": null,
"ScheduleTimeZone": "UTC+8",
"StartTime": "2026-01-05 00:00:00",
"TaskAction": "",
"Tasks": [
{
"InChargeIdList": [
"100043952931"
],
"InChargeNameList": [
"brianfzhang"
],
"ScheduleTimeZone": null,
"TaskId": "20250826201812341",
"TaskName": "t01",
"TaskType": "1",
"WorkflowId": "cd1e7bda-8672-4a6e-b71a-0195084a04f1"
}
],
"TriggerTypes": [
"CYCLE"
]
},
"GroupType": "DEFAULT",
"InstanceId": null,
"MonitorStatus": true,
"MonitorType": 2,
"Name": "mico_rule_group_101",
"Permission": true,
"PipelineTaskCount": 1,
"RuleCount": 1,
"RuleGroupId": 743,
"SchemaName": null,
"Subscription": null,
"TableId": null,
"TableName": "gee01",
"TableOwnerName": null,
"TableOwnerUserId": null,
"UpdateTime": "2026-01-05 17:09:27"
}
],
"TotalCount": 1
},
"RequestId": "70b3c2b2-1e1f-413f-8a88-8fba5dc87996"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidFilterParameter | 查询过滤条件参数错误。 |
| UnauthorizedOperation.UserNotInProject | 用户不是当前项目成员。 |