tencent cloud

APIs

DescribeGlobalConfig

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-10-10 14:59:02

1. API Description

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

This API is used to query the global configuration of YARN resource scheduling.

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: DescribeGlobalConfig.
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 English ID of the EMR cluster.

3. Output Parameters

Parameter Name Type Description
EnableResourceSchedule Boolean Whether the resource scheduling feature is enabled.
ActiveScheduler String Currently effective resource scheduler.
CapacityGlobalConfig CapacityGlobalConfig Information of the fair scheduler.
FairGlobalConfig FairGlobalConfig Information of the capacity scheduler.
Scheduler String Latest resource scheduler.
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 Querying the Global Configuration of YARN Resource Scheduling

Input Example

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

{
    "InstanceId": "emr-xxx"
}

Output Example

{
    "Response": {
        "ActiveScheduler": "fair",
        "CapacityGlobalConfig": {
            "DefaultSettings": [
                {
                    "Desc": "Specifies the number of times scheduling can be delayed to ensure task localization. If the value is -1, delayed scheduling is disabled.",
                    "Key": "yarn.scheduler.capacity.node-locality-delay",
                    "Name": "node-locality-delay",
                    "Prompt": "Enter -1, 0, or a positive integer.",
                    "Value": null
                },
                {
                    "Desc": "Specifies whether to allocate multiple containers in a single NodeManager heartbeat. The default value is true. ResourceManager restart is required.",
                    "Key": "yarn.scheduler.capacity.per-node-heartbeat.multiple-assignments-enabled",
                    "Name": "multiple-assignments-enabled",
                    "Prompt": "Enter true or false.",
                    "Value": null
                },
                {
                    "Desc": "Maximum number of containers that can be allocated in a single NodeManager heartbeat if multiple-assignments-enabled is true. ResourceManager restart is required.",
                    "Key": "yarn.scheduler.capacity.per-node-heartbeat.maximum-container-assignments",
                    "Name": "maximum-container-assignments",
                    "Prompt": "Enter -1 or a positive integer.",
                    "Value": null
                },
                {
                    "Desc": "ResourceCalculator implementation used to compare resources in the scheduler. The default org.apache.hadoop.yarn.util.resource.DefaultResourceCalculator uses only memory, while org.apache.hadoop.yarn.util.resource.DominantResourceCalculator uses multidimensional resources such as memory and CPU. ResourceManager restart is required.",
                    "Key": "yarn.scheduler.capacity.resource-calculator",
                    "Name": "resource-calculator",
                    "Prompt": "Refer to the description for input.",
                    "Value": null
                }
            ],
            "EnableLabel": false,
            "LabelDir": null,
            "QueueMappingOverride": null
        },
        "EnableResourceSchedule": true,
        "FairGlobalConfig": {
            "UserMaxAppsDefault": null
        },
        "RequestId": "37bd53ed-7516-4a36-988e-e4afeb731df1",
        "Scheduler": "fair"
    }
}

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 Internal error.
InternalError.CamCgwError Internal service call exception.
InternalError.WoodServerError Internal service call exception.
InvalidParameter Parameter error.
InvalidParameter.InvalidInstanceName Invalid cluster name.
ResourceNotFound.InstanceNotFound The instance cannot be found.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan