ModifyGlobalConfig

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

ModifyGlobalConfig

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

1. API Description

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

This API is used to modify 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: ModifyGlobalConfig.
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.
Items.N	Yes	Array of Item	List of modified configurations. Key values have a one-to-one correspondence with the output parameters of the `DescribeGlobalConfig` API and are case-insensitive (if an error occurs indicating the key cannot be found, refer to the output parameters). The values are: 1. enableResourceSchedule: Enables or disables resource scheduling. When disabling, a synchronous operation option (sync) is available with values true or false. 2. scheduler type: scheduler. 2. enableLabel: Enables or disables tags, with values true or false. 2. tag directory: labelDir. 3. whether to overwrite the user-specified queue, with values true or false. 4. userMaxAppsDefault: program upper limit. 5. dynamic configuration item: Corresponds to the Name field in the DefaultSettings object returned by the DescribeGlobalConfig API. The values are strings. For whether to overwrite the user-specified queue and program upper limit, null in the JSON specifications means clearing the value of this configuration. Individual configuration items can be modified. For dynamic configurations, a full transmission is required to perform overwriting.

3. Output Parameters

Parameter Name	Type	Description
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 Modifying Global Configuration of YARN Resource Scheduling

Input Example

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

{
    "InstanceId": "emr-123",
    "Items": [
        {
            "Key": "enableResourceSchedule",
            "Value": "true"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "514a7860-f50f-49ec-92eb-6d4558ec45c3"
    }
}

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	Internal error.
InternalError.CamCgwError	An error occurred while calling another service API.
InternalError.WoodServerError	An error occurred while calling another service API.
InvalidParameter	Invalid parameter.
InvalidParameter.InvalidInstanceName	Invalid cluster name.
ResourceNotFound.InstanceNotFound	The instance was not found.

Was this page helpful?

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

Yes

Feedback

tencent cloud