DescribeInsightList

Last updated: 2025-11-13 20:49:05

DescribeInsightList

Last updated: 2025-11-13 20:49:05

1. API Description

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

This API is used to obtain insight result 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: DescribeInsightList.
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	Start time of the obtained insight result. The time is specific for filtering the start time of App or Hive querying.
EndTime	Yes	Integer	End time of the obtained insight result. The time is specific for filtering the start time of App or Hive querying.
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.
Type	No	String	Query type. Types such as Hive,Spark,DLC_Spark,Spark_SQL,SCHEDULE,MapReduce,Trino are supported. All are queried by default.
MustHasContext	No	Boolean

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number, which is used for pagination query.
ResultList	Array of InsightResult	Insight result array. 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 Obtaining Insight Information

Input Example

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

{
    "InstanceId": "emr-d82w3t9p",
    "PageSize": 10,
    "StartTime": 1701792000,
    "EndTime": 1701878399,
    "Page": 1
}

Output Example

{
    "Response": {
        "TotalCount": 9,
        "RequestId": "12345678999",
        "ResultList": [
            {
                "ScheduleTaskName": "",
                "RuleID": "HIVE-ScanManyPartition",
                "ScheduleTaskExecID": "",
                "ScheduleFlowName": "",
                "Detail": "easechen_dw.test_orc big scan",
                "Value": 0,
                "RuleExplain": "The number of scanned partitions exceeds 80% of the total table partitions.",
                "Suggestion": "Add partitioned scan conditions.",
                "RuleName": "HIVE-Large Table Scan",
                "JobConf": "",
                "Type": "HIVE",
                "ID": "hadoop_20231206140857_1bbd81e2-b752-424b-aa61-a811a40c3099"
            }
        ]
    }
}

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

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

Error Code	Description
ResourceNotFound.ClusterNotFound	The instance was not found.
UnauthorizedOperation.AppIdMismatched	The `appId` is inconsistent.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud