Domain name for API request: emr.intl.tencentcloudapi.com.
This API is used to scale out cluster nodes.
A maximum of 20 requests can be initiated per second for this API.
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 | Node billing mode. Valid values: |
| InstanceId | Yes | String | Cluster ID. |
| ScaleOutNodeConfig | Yes | ScaleOutNodeConfig | Type and number of nodes for the scale-out. |
| ClientToken | No | String | Unique random identifier, which is valid for five minutes and needs to be specified by the caller. This prevents the client from repeatedly creating resources. Example value: a9a90aa6---****-fae36063280. |
| InstanceChargePrepaid | No | InstanceChargePrepaid | Parameter settings related to yearly/monthly subscription. This parameter can be used to specify the purchase duration of a yearly/monthly subscription instance, whether to enable auto-renewal, and other attributes. This parameter is required if the billing mode of the specified instance is prepaid. |
| ScriptBootstrapActionConfig.N | No | Array of ScriptBootstrapActionConfig | Bootstrap operation script settings. |
| SoftDeployInfo.N | No | Array of Integer | To scale out deployment services, new nodes will inherit the services deployed on the current node type by default. The deployment service includes default optional services. This parameter is supported only when optional services are used. For example, if existing task nodes have HDFS, YARN, and impala deployed, when using the API to scale out Task nodes without deploying impala, fill in only HDFS and YARN for the deployment service. For details, see Component Name Mapping Table. |
| ServiceNodeInfo.N | No | Array of Integer | Deployment processes. By default, all processes of the scaled‑out service are deployed. Deployment processes can be modified. For example, if the deployed services for the current task node are HDFS, YARN, and impala, the default deployment services are DataNode, NodeManager, and ImpalaServer. If you need to modify deployment process information, the deployment processes can be DataNode, NodeManager, and ImpalaServerCoordinator or DataNode, NodeManager, and ImpalaServerExecutor. For details, see Process Name Mapping Table. |
| DisasterRecoverGroupIds.N | No | Array of String | List of dispersed placement group IDs. Currently, only one ID can be specified. |
| Tags.N | No | Array of Tag | List of tags bound to nodes for the scale-out. |
| HardwareSourceType | No | String | Resource type selected for the scale-out. Valid values: "HOST", "POD", and "MNode". HOST indicates ordinary CVM resources, POD indicates resources provided by a TKE cluster or an EKS cluster, and MNode indicates fully managed resources. |
| PodSpecInfo | No | PodSpecInfo | Pod-related resource information. |
| ClickHouseClusterName | No | String | Machine group name selected for the ClickHouse cluster scale-out. |
| ClickHouseClusterType | No | String | Machine group type selected for the ClickHouse cluster scale-out. Valid values: new (adds a group) and old (selects an existing group). |
| YarnNodeLabel | No | String | YARN node label specified for the scale-out. |
| EnableStartServiceFlag | No | Boolean | Whether to start the service after a scale-out. Default value: false. Valid values: |
| ResourceSpec | No | NodeResourceSpec | Specification settings. |
| Zone | No | String | AZ to which the instance belongs, for example, ap-guangzhou-1. This parameter can be obtained from the Zone field in the response of DescribeZones. |
| SubnetId | No | String | Subnet. The subnet used during cluster creation is selected by default. |
| ScaleOutServiceConfGroupsInfo.N | No | Array of ScaleOutServiceConfGroupsInfo | Configuration group specified for the scale-out. |
| NodeMarks | No | NodeMark | Node flag information, which is currently only provided for the Terraform platform. |
| WarehouseName | No | String | Name of the compute group specified for the scale-out. |
| PartitionNumber | No | Integer | Partition of a partition placement group. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| ClientToken | String | Client token. |
| FlowId | Integer | Scale-out flow ID. |
| TraceId | String | Used to query the flow status and additional flow information. |
| DealNames | Array of String | Order number. |
| 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. |
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": []
}
}{
"Response": {
"ClientToken": "",
"FlowId": 19239,
"InstanceId": "emr-m620",
"RequestId": "11f53a6c-df44-4496-acac-d09b98ccd",
"TraceId": "1731400002-73146-8002"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 obtain the CVM specifications information. |
| InvalidParameter.InvalidInstanceChargeType | Illegal instance billing mode. |
| InvalidParameter.InvalidInstanceType | Invalid instance type. |
| InvalidParameter.InvalidNodeFlag | Illegal node type. |
| InvalidParameter.InvalidSoftDeployInfo | The InvalidSoftDeployInfo parameter is invalid or incorrect. |
| ResourceInUse.InstanceInProcess | The instance is in process. |
| ResourceInsufficient.DiskInsufficient | The specifications of the hard disk do not meet the requirements. |
| ResourceInsufficient.InstanceInsufficient | The node specifications are not supported or have been sold out. |
| ResourceNotFound.InstanceNotFound | The instance cannot be found. |
| ResourceUnavailable.ResourceSpecNotDefaultSpec | The current resource specifications do not have the default specifications. |
フィードバック