数据开发治理平台 WeData 查询表质量详情-数据质量相关接口-API 中心-腾讯云

1. 接口描述

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

质量报告-查询表质量详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTableQualityDetails。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
StatisticsDate	是	Integer	统计日期示例值：1679414400
ProjectId	是	String	项目id 示例值：153161111111111111
PageNumber	是	Integer	分页序号示例值：1
PageSize	是	Integer	分页大小示例值：10
Filters.N	否	Array of Filter	过滤参数TableName、DatabaseId 、DatabaseName、OwnerUserName 示例值：[ { "Name": "StartTime", "Values": [ "1712160000" ] }, { "Name": "EndTime", "Values": [ "1712764799" ] } ] } ]
OrderFields.N	否	Array of OrderField	排序参数排序方式 DESC 或者 ASC，表得分排序 TableScore 示例值：[ { "Name": "CitationCount", "Direction": "DESC" } ]
DatasourceId	否	String	数据来源id 示例值：sykhj23ds-dsdh
ScoreType	否	String	1:按全维度权重计算,2:按已配置维度权重计算,3:不按维度权重计算,默认1 示例值：1

3. 输出参数

参数名称	类型	描述
Data	TableQualityDetailPage	表质量分详情结果注意：此字段可能返回 null，表示取不到有效值。示例值：{ "TotalCount": 4, "Items": [ { "DatabaseId": "dsadasd-dsad", "DatabaseName": "dq_db1", "TableId": "dsjklj-jkjk", "TableName": "dq_table1", "OwnerUserId": 100333290099, "OwnerUserName": "zhangsna", "DatabaseScore": 0.8, "TableScore": 12.0, "LastPeriodRatio": 0.18 } ] }
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 分页查询表数据质量详情

分页查询表数据质量详情

输入示例

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

{
    "PageSize": 1,
    "ProjectId": "153161111111111111",
    "StatisticsDate": 1679414400,
    "DatasourceId": "dsadsa-dsadihjks",
    "OrderFields": [
        {
            "Direction": "DESC",
            "Name": "TableScore"
        }
    ],
    "PageNumber": 0,
    "Filters": [
        {
            "Values": [
                "TableName"
            ],
            "Name": "dq_table1"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "f2a131b8-0dd3a028",
        "Data": {
            "TotalCount": 4,
            "Items": [
                {
                    "DatabaseId": "dsadasd-dsad",
                    "DatabaseName": "dq_db1",
                    "TableId": "dsjklj-jkjk",
                    "TableName": "dq_table1",
                    "OwnerUserId": 100333290099,
                    "OwnerUserName": "zhangsna",
                    "DatabaseScore": 0.8,
                    "TableScore": 12.0,
                    "LastPeriodRatio": 0.18
                }
            ]
        }
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.SignatureExpire	未登录或登录已过期。
AuthFailure.UnauthorizedOperation	CAM未授权，请联系主账号到CAM中授权QcloudWeDataFullAccess策略给该账户。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。

查询表质量详情

本页目录：