Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

DescribeQueryAnalyse

Last updated: 2024-09-14 11:01:32

Download PDF

1. API Description

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

This API is used to obtain the SQL query details of the Doris user.

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: DescribeQueryAnalyse.
Version	Yes	String	Common Params. The value used for this API: 2021-12-28.
Region	No	String	Common Params. This parameter is not required for this API.
InstanceId	Yes	String	Instance ID
UserName	No	String	Use the user who has corresponding permissions for operations. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
PassWord	No	String	Password corresponding to the user. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
StartTime	No	String	Start time of operation period
EndTime	No	String	End time of operation period.
SQLFragment	No	String	SQL fragments (fuzzy query supported)
CatalogFilter	No	String	Catalog filter condition
DatabaseFilter	No	String	Database name filter condition
SQLTypeFilter	No	String	SQL type filter criteria
SortField	No	String	Sorting field
SortOrder	No	String	Sorting order: asc (ascending) or desc (descending)
QueryTime	No	Integer	Minimum query execution time, in milliseconds.
PageNum	No	Integer	Page number, defaults to 1.
PageSize	No	Integer	Number of records per page, defaults to 10.

3. Output Parameters

Parameter Name	Type	Description
QueryDetails	Array of QueryDetails	Query details
TotalCount	Integer	Total number of records
CurrentPage	Integer	Current page
PageSize	Integer	Number of records per page
TotalPages	Integer	Total pages
Message	String	Error message
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 Querying

Input Example

POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeQueryAnalyse
<Common request parameters>

{
     "InstanceId": "cdwdoris-7da9fumk",
    "QueryTime": 0,
    "StartTime": "2024-08-04 09:53:24",
    "EndTime": "2025-08-28 09:53:24",
    "SQLFragment": "",
    "CatalogFilter": "internal",
    "DatabaseFilter": "__internal_schema",
    "SQLTypeFilter": "-1",
    "SortField": "Duration",
    "SortOrder": "ASC"

}

Output Example

{
    "Response": {
        "QueryDetails": [
            {
                "Initiator": "abc",
                "SourceAddress": "abc",
                "InitialRequestId": "abc",
                "Catalog": "abc",
                "Database": "abc",
                "SQLType": "abc",
                "SQLStatement": "abc",
                "StartTime": "abc",
                "Duration": 1,
                "RowsRead": 1,
                "DataRead": 0,
                "MemoryUsage": 0
            }
        ],
        "TotalCount": 1,
        "CurrentPage": 1,
        "PageSize": 1,
        "TotalPages": 1,
        "RequestId": "abc"
    }
}

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

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Recent Pages

DescribeQueryAnalyse

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeQueryAnalyse

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?