tencent cloud

Feedback

DescribeEmrApplicationStatics

Last updated: 2022-09-23 16:16:03

1. API Description

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

This API is used to query the Yarn application statistics.

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: DescribeEmrApplicationStatics.
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 No Integer Start time in the format of timestamp. Unit: seconds.
EndTime No Integer End time in the format of timestamp. Unit: seconds.
Queues.N No Array of String Queue name used for filtering
Users.N No Array of String Username used for filtering
ApplicationTypes.N No Array of String Application type used for filtering
GroupBy.N No Array of String Group field. Valid values: queue, user, and applicationType.
OrderBy No String Sorting field. Valid values: sumMemorySeconds, sumVCoreSeconds, sumHDFSBytesWritten, and sumHDFSBytesRead.
IsAsc No Integer Order type. Valid values: 0 (descending) and 1(ascending).
Offset No Integer Page number
Limit No Integer Page limit

3. Output Parameters

Parameter Name Type Description
Statics Array of ApplicationStatics Application statistics
TotalCount Integer Total count
Queues Array of String Available queue name
Users Array of String Available usernames
ApplicationTypes Array of String Available application type
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 【Monitor】Querying the application statistics V2

Input Example

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

{
    "InstanceId": "emr-9kd5tnmq"
}

Output Example

{
    "Response": {
        "ApplicationTypes": [
            "MAPREDUCE"
        ],
        "Queues": [
            "root.default"
        ],
        "RequestId": "12345678",
        "Statics": [
            {
                "Queue": "root.default",
                "User": "hadoop",
                "ApplicationType": "MAPREDUCE",
                "SumMemorySeconds": 58250,
                "SumVCoreSeconds": 33,
                "SumHDFSBytesWritten": "48 bytes",
                "SumHDFSBytesRead": "269 bytes",
                "CountApps": 0
            }
        ],
        "TotalCount": 1,
        "Users": [
            "hadoop"
        ]
    }
}

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
InternalError.CamCgwError An error occurred while calling another service API.
ResourceNotFound.InstanceNotFound The instance was not found.
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