1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询规则组详情接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRuleGroup。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| RuleGroupId | 否 | Integer | 规则组ID 示例值：123456 |
| DatasourceId | 否 | String | 数据来源ID 示例值：123456 |
| TableId | 否 | String | 数据表Id 示例值：65R7TYFU9862YE |
| ProjectId | 否 | String | 项目ID 示例值：123456 |
| DatabaseId | 否 | String | 数据库ID 示例值：7568tfvgy57tfvgy |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | RuleGroup | 数据质量规则组详情 注意：此字段可能返回 null，表示取不到有效值。 示例值：{ "CreateTime": null, "DatabaseId": null, "DatabaseName": "v_vzjfzng", "DatasourceId": null, "DatasourceName": "hive_er-o5bxp", "DatasourceType": 2, "ExecStrategy": null, "InstanceId": "emr-ovzb5bxp", "MonitorStatus": true, "MonitorType": null, "Permission": true, "RuleCount": 0, "RuleGroupId": null, "Subscription": null, "TableId": "XuKflA-wQbbohxQbg", "TableName": "test", "TableOwnerName": "zheyuang", "TableOwnerUserId": null, "UpdateTime": null } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询规则组详情接口
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRuleGroup
<公共请求参数>
{
"ProjectId": "5678987645",
"DatabaseId": "5rtfygfty6767tyug",
"TableId": "56tdryfccfyrt556t",
"DatasourceId": "44567",
"RuleGroupId": 1
}输出示例
{
"Response": {
"Data": {
"CreateTime": null,
"DatabaseId": null,
"DatabaseName": "v_vzjfzng",
"DatasourceId": null,
"DatasourceName": "hive_er-o5bxp",
"DatasourceType": 2,
"ExecStrategy": null,
"InstanceId": "emr-ovzb5bxp",
"MonitorStatus": true,
"MonitorType": null,
"Permission": true,
"RuleCount": 0,
"RuleGroupId": null,
"Subscription": null,
"TableId": "XuKflA-wQbbohxQbg",
"TableName": "test",
"TableOwnerName": "zheyuang",
"TableOwnerUserId": null,
"UpdateTime": null
},
"RequestId": "7c8ef235-4c4f-4b8b-8-0303d9dc1"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.InvalidFilterParameter | 查询过滤条件参数错误。 |
| UnauthorizedOperation.UserNotInProject | 用户不是当前项目成员。 |