tencent cloud

DescribeStarRocksQueryInfo
Last updated: 2025-11-13 20:49:02
DescribeStarRocksQueryInfo
Last updated: 2025-11-13 20:49:02

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to query StarRocks information.

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: DescribeStarRocksQueryInfo.
Version Yes String Common Params. The value used for this API: 2019-01-03.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Cluster ID.
StartTime Yes Integer Query information obtainment start time (seconds).
EndTime Yes Integer Query information obtainment end time (seconds).
PageSize Yes Integer Page size for pagination query. The minimum value is 1, and the maximum value is 100.
Page Yes Integer Page number for pagination queries, starting from 1.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number, which is used for pagination query.
StarRocksQueryInfoList Array of StarRocksQueryInfo StarRocks information list.
Note: This field may return null, indicating that no valid values 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 DescribeStarRocksQueryInfo

Input Example

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

{
    "InstanceId": "emr-1qop4l3e",
    "PageSize": 10,
    "Page": 1,
    "StartTime": 1722327682,
    "EndTime": 1722328091
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "StarRocksQueryInfoList": [
            {
                "ClientIP": "192.0.0.1",
                "CPUCost": 0,
                "DefaultDB": "db_test",
                "EndTime": 1721962352,
                "ExecutionIP": "192.0.0.1",
                "QueryID": "1ac25f6c-4afa-11ef-b7cc-525400c756d2",
                "QueryType": "OTHERS",
                "MemCost": 324,
                "PlanCpuCosts": 435620,
                "PlanMemCosts": 254354,
                "QueryTime": 345535,
                "ResourceGroup": "SR",
                "ReturnRows": 2452,
                "ScanBytes": 1235124,
                "ScanRows": 123512,
                "BeginTime": 1721962352,
                "ExecutionState": "FINISHED",
                "ExecutionStatement": "show compute nodes",
                "User": "test_aa"
            }
        ],
        "RequestId": "1ac25f6c-4afa-11ef-b7cc-525400454wfaa1"
    }
}

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
InvalidParameter.InvalidClusterId Invalid parameter: ClusterId.
UnauthorizedOperation.AppIdMismatched The appId is inconsistent.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback