DescribeHiveQueries

Download PDF

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

DescribeHiveQueries

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

Download PDF

1. API Description

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

This API is used to inquiry Hive query data.

A maximum of 100 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: DescribeHiveQueries.
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	The cluster ID.
StartTime	Yes	Integer	The start time in seconds.
EndTime	Yes	Integer	The end time in seconds. EndTime-StartTime should not exceed one day's duration, which is 86400 seconds.
Offset	Yes	Integer	Starting offset for pagination. Start value: 0
Limit	Yes	Integer	Page size. Valid range: [1,100]
State.N	No	Array of String	Execution status, for example, ERROR.
EndTimeGte	No	Integer	Time point earlier than the end time.
EndTimeLte	No	Integer	Time point later than the end time.

3. Output Parameters

Parameter Name	Type	Description
Total	Integer	Total items
Results	Array of HiveQuery	Result list
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 Inquiring Hive Query Data

Inquiring Hive Query Data

Input Example

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

{
    "InstanceId": "emr-qy2p6mem",
    "Offset": 0,
    "Limit": 2,
    "StartTime": 1685633400,
    "EndTime": 1686239999
}

Output Example

{
    "Response": {
        "Total": 287,
        "RequestId": "12345678999",
        "Results": [
            {
                "ExecutionEngine": "mr",
                "Statement": "insert into oozie_hive2 values(1, 'oozie1'),(2, 'oozie2')",
                "JobIds": [
                    "application_1686021938406_0191"
                ],
                "State": "FINISHED",
                "User": "hadoop",
                "StartTime": 1686064102000,
                "Duration": "104ms",
                "EndTime": 1686064207000,
                "Id": "hadoop_20230606150822_d1c216ea-7602-4fc6-9a20-5c0287f062ff"
            },
            {
                "ExecutionEngine": "mr",
                "Statement": "create table if not exists oozie_hive2(id int, name string)",
                "JobIds": [],
                "State": "FINISHED",
                "User": "hadoop",
                "StartTime": 1686064093000,
                "Duration": "8ms",
                "EndTime": 1686064102000,
                "Id": "hadoop_20230606150813_20c9784a-564c-4b80-9505-e46392cbb152"
            }
        ]
    }
}

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
InternalError.DBQueryException	Database query error.
InvalidParameter.ImpalaQueryException	Impala query parameter error.
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