tencent cloud

APIs

DescribeYarnScheduleHistory

Download
Focus Mode
Font Size
Last updated: 2026-10-10 14:58:21

1. API Description

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

This API is used to view the YARN resource scheduling history. It has been deprecated. Please use Task Center to view the history records.

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: DescribeYarnScheduleHistory.
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.
EndTime No Integer End time.
Limit No Integer Page number.
Offset No Integer Number of entries per page.
SchedulerType No String Scheduler type. Valid values: ALL, Capacity Scheduler, and Fair Scheduler.
TaskState No Integer Task type. Valid values: 0 (pending execution), 1 (executing), 2 (completed), -1 (failed), and -99 (all).

3. Output Parameters

Parameter Name Type Description
Tasks Array of SchedulerTaskInfo Task details.
Total Integer Total quantity of task details.
SchedulerNameList Array of String Scheduling type filter list.
StateList Array of Integer Status filter 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 Viewing the YARN Resource Scheduling History

Input Example

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

{
    "InstanceId": "emr-a903oah8",
    "StartTime": 1722873600,
    "EndTime": 1722959999,
    "Limit": 10,
    "Offset": 0,
    "SchedulerType": "All",
    "TaskState": -99
}

Output Example

{
    "Response": {
        "RequestId": "c38e1833-e164-488c-9817-e8ca75d8d214",
        "SchedulerNameList": [
            "Capacity Scheduler",
            "Fair Scheduler"
        ],
        "StateList": [
            0,
            1,
            2,
            -1
        ],
        "Tasks": [
            {
                "CreateTime": "2024-08-07 19:13:38",
                "Details": [
                    {
                        "FailReason": "",
                        "JobId": 40005,
                        "Progress": "9%",
                        "Step": "Start"
                    },
                    {
                        "FailReason": "",
                        "JobId": 40005,
                        "Progress": "45%",
                        "Step": "Write capacity-scheduler.xml."
                    },
                    {
                        "FailReason": "",
                        "JobId": 40005,
                        "Progress": "63%",
                        "Step": "Restart resource manager."
                    },
                    {
                        "FailReason": "",
                        "JobId": 40005,
                        "Progress": "100%",
                        "Step": "End"
                    }
                ],
                "EndTime": "2024-08-07 19:13:48",
                "OperatorName": "change capacity scheduler,disable label,refresh dynamic pools,restart resource manager",
                "SchedulerName": "Capacity Scheduler",
                "State": 2
            },
            {
                "CreateTime": "2024-08-06 14:30:02",
                "Details": [
                    {
                        "FailReason": "",
                        "JobId": 40000,
                        "Progress": "9%",
                        "Step": "Start"
                    },
                    {
                        "FailReason": "",
                        "JobId": 40000,
                        "Progress": "45%",
                        "Step": "Write capacity-scheduler.xml."
                    },
                    {
                        "FailReason": "The task was canceled because of a timeout",
                        "JobId": 40000,
                        "Progress": "63%",
                        "Step": "Restart resource manager."
                    }
                ],
                "EndTime": "2024-08-06 14:35:05",
                "OperatorName": "change capacity scheduler,disable label,refresh dynamic pools,restart resource manager",
                "SchedulerName": "Capacity Scheduler",
                "State": -1
            },
            {
                "CreateTime": "2024-08-06 11:29:15",
                "Details": [
                    {
                        "FailReason": "",
                        "JobId": 39994,
                        "Progress": "9%",
                        "Step": "Start"
                    },
                    {
                        "FailReason": "",
                        "JobId": 39994,
                        "Progress": "45%",
                        "Step": "Write capacity-scheduler.xml."
                    },
                    {
                        "FailReason": "",
                        "JobId": 39994,
                        "Progress": "63%",
                        "Step": "Restart resource manager."
                    },
                    {
                        "FailReason": "",
                        "JobId": 39994,
                        "Progress": "100%",
                        "Step": "End"
                    }
                ],
                "EndTime": "2024-08-06 11:29:25",
                "OperatorName": "change capacity scheduler,disable label,refresh dynamic pools,restart resource manager",
                "SchedulerName": "Capacity Scheduler",
                "State": 2
            }
        ],
        "Total": 3
    }
}

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 Internal service call exception.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback