ScaleOutCluster

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

ScaleOutCluster

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

1. API Description

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

This API is used to scale out a cluster.

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: ScaleOutCluster.
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.
InstanceChargeType	Yes	String	The node billing mode. Valid values: `POSTPAID_BY_HOUR`: The postpaid mode by hour. `SPOTPAID`: The spot instance mode (for task nodes only).
InstanceId	Yes	String	Cluster instance ID.
ScaleOutNodeConfig	Yes	ScaleOutNodeConfig	Scale-up node type and quantity.
ClientToken	No	String	Unique random identifier with the time efficiency of 5 minutes, which needs to be specified by the caller to prevent the client from creating resources again, for example, a9a90aa6---****-fae36063280.
InstanceChargePrepaid	No	InstanceChargePrepaid	Setting of parameters related to monthly subscription. Through this parameter, you can specify the duration of purchase for monthly subscription instances, whether to set auto-renewal, and other attributes. This parameter is required when the specified instance is subject to the payment mode of prepaid.
ScriptBootstrapActionConfig.N	No	Array of ScriptBootstrapActionConfig	Bootstrap Actions script settings.
SoftDeployInfo.N	No	Array of Integer	Scale-out deployment service. New nodes inherit services deployed in the current node type by default, including default optional services. This parameter only supports optional service filling, for example: HDFS, YARN, and Impala have been deployed to existing task nodes. When API is used to scale out the task nodes without deploying Impala, only HDFS and YARN are filled for deployment services. For more details, see Mapping Table of Component Names.
ServiceNodeInfo.N	No	Array of Integer	Deployment process. By default, all scale-out service processes are deployed. Deployment processes can be modified. For example, HDFS, YARN, or Impala has been deployed for the current Task node. The default deployment services include DataNode,NodeManager,ImpalaServer. If users need to modify deployment process information, the deployment process can be DataNode, NodeManager, ImpalaServerCoordinator or DataNode, NodeManager, ImpalaServerExecutor. For more details, see Mapping Table of Process Names.
DisasterRecoverGroupIds.N	No	Array of String	Spread placement group ID list. Only one can be specified currently. This parameter can be obtained by calling the DisasterRecoverGroupId field in the return value of the DescribeDisasterRecoverGroups API.
Tags.N	No	Array of Tag	List of tags bound to scale-out nodes.
HardwareSourceType	No	String	Resource type selected for scale-out with valid values "HOST","POD","MNode", where HOST indicates an ordinary CVM resource, POD indicates a resource provided by the TKE cluster or EKS cluster, and MNode indicates a fully managed resource type.
PodSpecInfo	No	PodSpecInfo	Pod-related resource information.
ClickHouseClusterName	No	String	Machine group name selected for ClickHouse cluster scale-out.
ClickHouseClusterType	No	String	Machine group type selected for ClickHouse cluster scale-out. "New" indicates creating a group type, and "old" indicates using an existing group type.
YarnNodeLabel	No	String	Specified Yarn Node Label for scale-out.
EnableStartServiceFlag	No	Boolean	Whether to start a service after scale-out (default: false). true: yes . false: no .
ResourceSpec	No	NodeResourceSpec	Specifications settings.
Zone	No	String	Availability zone of the instance, such as ap-guangzhou-1. This parameter can also be obtained from the Zone field in the return value of DescribeZones.
SubnetId	No	String	Subnet, which is the subnet at the time of cluster creation by default.
ScaleOutServiceConfGroupsInfo.N	No	Array of ScaleOutServiceConfGroupsInfo	Configuration group specified for scale-out.
NodeMarks	No	NodeMark	Node tag information: currently used only in Terraform.

3. Output Parameters

Parameter Name	Type	Description
InstanceId	String	Instance ID.
ClientToken	String	Client token.
FlowId	Integer	Scale-out process ID.
TraceId	String	Query process status and additional flow formation.
DealNames	Array of String	Order number. Note: This field may return null, indicating that no valid values can be obtained.
BillId	String	Large order number.
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 Scaling Out Clusters

Input Example

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

{
    "InstanceChargeType": "PREPAID",
    "InstanceId": "emr-m620",
    "ScaleOutNodeConfig": {
        "NodeFlag": "TASK",
        "NodeCount": 2
    },
    "SoftDeployInfo": [
        1,
        2
    ],
    "ServiceNodeInfo": [
        7
    ],
    "YarnNodeLabel": "CLOUD",
    "EnableStartServiceFlag": true,
    "ResourceSpec": {
        "SystemDisk": [
            {
                "DiskType": "CLOUD_PREMIUM",
                "DiskSize": 200,
                "Count": 1,
                "ExtraPerformance": 0
            }
        ],
        "DataDisk": [
            {
                "DiskType": "CLOUD_HIGHIO",
                "DiskSize": 4000,
                "Count": 4,
                "ExtraPerformance": 0
            }
        ],
        "LocalDataDisk": [],
        "InstanceType": "MA5.8XLARGE256",
        "Tags": []
    }
}

Output Example

{
    "Response": {
        "ClientToken": "",
        "FlowId": 19239,
        "InstanceId": "emr-m620",
        "RequestId": "11f53a6c-df44-4496-acac-d09b98ccd",
        "TraceId": "1731400002-73146-8002"
    }
}

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
FailedOperation	Operation failed.
FailedOperation.GetCvmConfigQuotaFailed	Failed to fetch the specifications of the CVM.
InvalidParameter.InvalidInstanceChargeType	Invalid instance billing mode.
InvalidParameter.InvalidInstanceType	Invalid model.
InvalidParameter.InvalidNodeFlag	Incorrect node type.
InvalidParameter.InvalidSoftDeployInfo	The `InvalidSoftDeployInfo` parameter is invalid or incorrect.
ResourceInUse.InstanceInProcess	The instance is under workflow.
ResourceInsufficient.DiskInsufficient	The disk specification is insufficient.
ResourceInsufficient.InstanceInsufficient	The node specification is unsupported or has been sold out.
ResourceNotFound.InstanceNotFound	The instance was not found.
ResourceUnavailable.ResourceSpecNotDefaultSpec	There is no default value of the current resource spec.

Was this page helpful?

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

Yes

Feedback

tencent cloud