1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
查询监控列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListQualityRuleGroupsTable。 |
| Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目Id 示例值:9348672 |
| PageNumber | 否 | Integer | 分页序号,默认1 示例值:1 |
| PageSize | 否 | Integer | 分页大小,默认10 示例值:11 |
| Filters.N | 否 | Array of Filter | 过滤条件, 可选过滤条件如下: 1. GroupType 描述:规则组类型,标识规则组所属的分类。 取值:DEFAULT - 默认类型;DASHBOARD-仪表盘类型;WORKFLOW_NODE - 编排空间工作流节点类型 2. DeployStatus 描述:规则组部署状态,主要用于WORKFLOW_NODE类型的规则组 取值:PRODUCTION - 生产环境;DRAFT - 草稿套 3. RuleGroupName 描述:规则组名称。 取值:字符串 4. RuleGroupId 描述:规则组ID。 取值:整数 5. TableOwnerName 描述:表负责人名称,支持模糊匹配。 取值:字符串 6. TableOwnerAccount 描述:表负责人账号ID。 取值:整数,支持多个值(OR关系) 7. TableOwnerFlag 描述:是否为当前表负责人。 取值:true - 是;false - 否 8. 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 9. DatasourceId 描述:数据源ID。 取值:字符串 10. DatabaseName 描述:数据库名称。 取值:字符串 11. SchemaName 描述:Schema名称。 取值:字符串 12. TableName 描述:数据源表名称,支持模糊匹配。 取值:字符串 13. BizCatalogIds 描述:业务目录ID。 取值:整数,支持多个值(OR关系) 14. CatalogName 描述:数据目录名称。 取值:字符串 |
| OrderFields.N | 否 | Array of OrderField | 通用排序, 支持的排序字段: UpdateTime - 按更新时间排序(默认) 排序方向: 1 - 升序(ASC) 2 - 降序(DESC) |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | QualityRuleGroupsTableVO | 监控对象列表 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询规则组关联表信息
查询规则组关联表信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListQualityRuleGroupsTable
<公共请求参数>
{
"PageNumber": 1,
"PageSize": 10,
"ProjectId": "1464962169590902784"
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"CatalogName": null,
"CreateTime": "2025-11-26 12:06:32",
"DatabaseName": "default",
"DatasourceId": "61949",
"DatasourceName": "tchouse-x_instance-h3r2r46y",
"EnableRuleGroupCount": 1,
"Id": 353,
"InstanceId": null,
"RuleCount": 2,
"RuleGroupCount": 1,
"SchemaName": null,
"TableName": "bbb",
"TableOwnerName": null,
"TableOwnerUserId": null,
"UpdateTime": "2025-11-26 12:06:32"
},
{
"CatalogName": null,
"CreateTime": "2025-11-25 14:21:39",
"DatabaseName": "awq",
"DatasourceId": "8549",
"DatasourceName": "dlc_u54usqbq",
"EnableRuleGroupCount": 1,
"Id": 352,
"InstanceId": null,
"RuleCount": 1,
"RuleGroupCount": 1,
"SchemaName": null,
"TableName": "test_fq",
"TableOwnerName": null,
"TableOwnerUserId": null,
"UpdateTime": "2025-11-25 16:03:15"
},
{
"CatalogName": null,
"CreateTime": "2025-05-14 17:09:42",
"DatabaseName": "default",
"DatasourceId": "61557",
"DatasourceName": "hive_emr-onelrijj",
"EnableRuleGroupCount": 1,
"Id": 345,
"InstanceId": null,
"RuleCount": 1,
"RuleGroupCount": 1,
"SchemaName": null,
"TableName": "employee",
"TableOwnerName": null,
"TableOwnerUserId": null,
"UpdateTime": "2025-05-14 17:09:42"
}
],
"TotalCount": 3
},
"RequestId": "0f99dbd2-5ef7-4d90-a9ac-cef9eae0d1b7"
}
}
示例2 查询项目的某个数据源下已创建规则组(监控)的表信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListQualityRuleGroupsTable
<公共请求参数>
{
"ProjectId": "1470547050521227264",
"PageNumber": 1,
"PageSize": 10,
"Filters": [
{
"Name": "DatasourceType",
"Values": [
"3"
]
},
{
"Name": "DatasourceId",
"Values": [
"8860"
]
},
{
"Name": "DatabaseName",
"Values": []
},
{
"Name": "SchemaName",
"Values": []
}
],
"OrderFields": []
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"CatalogName": "DataLakeCatalog",
"CreateTime": "2025-01-21 16:21:29",
"DatabaseName": "at_dlc_cloud_gz_prod_mc",
"DatasourceId": "8860",
"DatasourceName": "dlc_DLC_hx756s1y",
"EnableRuleGroupCount": 1,
"Id": 328,
"InstanceId": null,
"RuleCount": 9,
"RuleGroupCount": 1,
"SchemaName": null,
"TableName": "gee01",
"TableOwnerName": null,
"TableOwnerUserId": null,
"UpdateTime": "2025-12-30 20:26:57"
}
],
"TotalCount": 1
},
"RequestId": "ac8ee1e0-3ff7-47dc-aa1d-59affc93de8f"
}
}
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 | 用户不是当前项目成员。 |