tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTableQualityDetails

Last updated: 2024-06-21 15:11:40

1. API Description

Domain name for API request: wedata.tencentcloudapi.com.

Quality Report - Query Table Quality Details

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeTableQualityDetails.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
StatisticsDate Yes Integer Statistics Date
ProjectId Yes String Project ID
PageNumber Yes Integer Pagination Index
PageSize Yes Integer Page size
Filters.N No Array of Filter Filter Parameters TableName, DatabaseId, DatabaseName, OwnerUserName
OrderFields.N No Array of OrderField Sorting Parameters Sort order DESC or ASC, Table score sorting TableScore
DatasourceId No String Data source ID
ScoreType No String 1: Calculate by full dimension weight, 2: Calculate by configured dimension weight, 3: Do not calculate by dimension weight, default is 1

3. Output Parameters

Parameter Name Type Description
Data TableQualityDetailPage Table quality score details result
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Paginate Query of Table Data Quality Details

Paginate Query of Table Data Quality Details

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableQualityDetails
<Common Request Parameters>{
    "PageSize": 1,
    "ProjectId": "153161111111111111",
    "StatisticsDate": 1679414400,
    "DatasourceId": "dsadsa-dsadihjks",
    "OrderFields": [
        {
            "Direction": "DESC",
            "Name": "TableScore"
        }
    ],
    "PageNumber": 0,
    "Filters": [
        {
            "Values": [
                "TableName"
            ],
            "Name": "dq_table1"
        }
    ]
}

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM Signature/Authentication Error.
AuthFailure.SignatureExpire Not logged in or login has expired.
AuthFailure.UnauthorizedOperation CAM not authorized, please contact the primary account to grant the QcloudWeDataFullAccess policy to this account.
FailedOperation Operation Failure.
InternalError An internal error occurs.
InvalidParameterValue Parameter value error.
UnauthorizedOperation Unauthorized Operation.
UnknownParameter Unknown parameter error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy