Domain name for API request: emr.intl.tencentcloudapi.com.
This API is used to scale out 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: ScaleOutInstance. |
| 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. |
| TimeUnit | Yes | String | Time unit for the scale-out. Valid values: |
| TimeSpan | Yes | Integer | Scale-out duration, which is used together with TimeUnit. |
| InstanceId | Yes | String | Instance ID. |
| PayMode | Yes | Integer | Instance billing mode. Valid values: |
| 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. |
| PreExecutedFileSettings.N | No | Array of PreExecuteFileSettings | Bootstrap script settings. |
| TaskCount | No | Integer | Number of Task nodes to be scaled out. |
| CoreCount | No | Integer | Number of scale-out Core nodes. |
| UnNecessaryNodeList.N | No | Array of Integer | Processes, which are not required during the scale-out. |
| RouterCount | No | Integer | Number of Router nodes to be scaled out. |
| SoftDeployInfo.N | No | Array of Integer | Deployed service. |
| ServiceNodeInfo.N | No | Array of Integer | Started process. |
| DisasterRecoverGroupIds.N | No | Array of String | List of dispersed placement group IDs. Currently, only one ID is supported. |
| Tags.N | No | Array of Tag | List of tags bound to nodes for the scale-out. |
| HardwareResourceType | 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. |
| PodSpec | No | PodSpec | Pod specifications and source information, which are specified when Pod resources are used for the scale-out. |
| 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 rule-based scale-out. |
| PodParameter | No | PodParameter | Pod custom permission and parameter. |
| MasterCount | No | Integer | Number of Master nodes for the scale-out. |
| StartServiceAfterScaleOut | No | String | Whether the service is started after the scale-out. Valid values: true (yes) and false (no). |
| ZoneId | No | Integer | AZ. The primary AZ of the cluster is selected by default. |
| SubnetId | No | String | Subnet. The subnet used during cluster creation is selected by default. |
| ScaleOutServiceConfAssign | No | String | Preset configuration group. |
| AutoRenew | No | Integer | Auto-renewal. Valid values: 0 (disabled) and 1 (enabled). |
| ResourceBaseType | No | String | Type. Valid values: ComputeResource and EMR. Default value: EMR. If this parameter is set to EMR, InstanceId takes effect. If this parameter is set to ComputeResource, ComputeResourceId is used. |
| ComputeResourceId | No | String | Computing resource ID. |
| ComputeResourceAdvanceParams | No | ComputeResourceAdvanceParams | Advanced settings of computing resources. |
| NodeMarks | No | NodeMark | Node tag information, which is currently only provided for the Terraform platform. |
| WarehouseName | No | String | Compute group specified for the scale-out. |
| PartitionNumber | No | Integer | Partition of a partition placement group. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| DealNames | Array of String | Order number. |
| ClientToken | String | Client token. |
| FlowId | Integer | Scale-out flow ID. |
| BillId | String | Large order number. |
| TraceId | String | TraceId for the scale-out. |
| 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: ScaleOutInstance
<Common request parameters>
{
"TimeUnit": "s",
"TimeSpan": 3600,
"InstanceId": "",
"PayMode": 0,
"ClientToken": "karpenter-15efec48d3bf2fa2",
"TaskCount": 1,
"HardwareResourceType": "HOST",
"ZoneId": 100002,
"SubnetId": "subnet-lrcxwbju",
"ResourceBaseType": "ComputeResource",
"ComputeResourceId": "emr-cr-j91kjr07",
"ComputeResourceAdvanceParams": {}
}{
"Response": {
"BillId": "20260903326023549811631",
"ClientToken": "karpenter-15efec48d3bf2fa2",
"DealNames": [
"20260903326023549811591"
],
"FlowId": 0,
"InstanceId": "emr-4hf4h9np",
"TraceId": "1788433513-296027-78000019",
"RequestId": "7208d49e-5c16-48fd-aa6e-2b10078bfb43"
}
}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.CheckIfSupportPodStretch | Operation failed. |
| FailedOperation.DuplicateOrderNotAllowed | Duplicate order. Please check the EMR console. |
| FailedOperation.GetCvmConfigQuotaFailed | Failed to obtain the CVM specifications information. |
| FailedOperation.GetCvmServerFailed | Failed to call the CVM service. |
| FailedOperation.NotSupportPod | Operation failed. Pod is not supported. |
| InternalError | Internal error. |
| InternalError.AccountCgwError | Internal service call exception. |
| InternalError.CamCgwError | Internal service call exception. |
| InternalError.CamError | Internal service call exception. |
| InternalError.CbsCgwError | Internal service call exception. |
| InternalError.CbsError | Internal service call exception. |
| InternalError.CdbCgwError | Internal service call exception. |
| InternalError.CdbError | Internal service call exception. |
| InternalError.ConfigCgwError | Internal service call exception. |
| InternalError.CvmError | Internal service call exception. |
| InternalError.EKSError | EKS call error. |
| InternalError.KmsError | Internal service call exception. |
| InternalError.ProjectCgwError | Internal service call exception. |
| InternalError.SgError | An exception occurred when the security group API is called. |
| InternalError.TKEError | TKE call error. |
| InternalError.TagError | Internal service call exception. |
| InternalError.TradeCgwError | Internal service call exception. |
| InternalError.VpcCgwError | Internal service call exception. |
| InternalError.VpcError | Internal service call exception. |
| InternalError.WoodServerError | Internal service call exception. |
| InvalidParameter | Parameter error. |
| InvalidParameter.AppIdResourceNotMatch | Parameter error. |
| InvalidParameter.InvalidAppId | Invalid parameter: APPID. |
| InvalidParameter.InvalidClickHouseCluster | Invalid ClickHouse cluster. |
| InvalidParameter.InvalidClientToken | Invalid ClientToken. |
| InvalidParameter.InvalidClusterId | Invalid parameter: ClusterId. |
| InvalidParameter.InvalidCoreCount | Invalid Core node quantity. |
| InvalidParameter.InvalidCount | The scale-out quantity must be greater than 0. |
| InvalidParameter.InvalidCountNum | The same request can only scale out Task or Core nodes. |
| InvalidParameter.InvalidCustomizedPodParam | Error message: Invalid PodParameter. |
| InvalidParameter.InvalidEksInstance | Invalid EKS instance. |
| InvalidParameter.InvalidInstanceName | Invalid cluster name. |
| InvalidParameter.InvalidJobFlow | Invalid flow task. |
| InvalidParameter.InvalidPaymode | Invalid payment type. |
| InvalidParameter.InvalidResourceSpec | Invalid resource specifications. |
| InvalidParameter.InvalidSercurityGrpupId | Invalid security group ID. |
| InvalidParameter.InvalidServiceNodeInfo | The ServiceNodeInfo parameter is invalid or incorrect. |
| InvalidParameter.InvalidSoftDeployInfo | The InvalidSoftDeployInfo parameter is invalid or incorrect. |
| InvalidParameter.InvalidTaskCount | The number of tasks cannot exceed 20. |
| InvalidParameter.InvalidTimeSpan | Invalid timespan. |
| InvalidParameter.InvalidTimeUnit | Invalid TimeUnit. |
| InvalidParameter.InvalidTkeInstance | Invalid TKE cluster ID, or the TKE cluster does not meet the criteria. |
| InvalidParameterValue.InvalidTkeInstance | Invalid TKE cluster ID, or the TKE cluster does not meet the criteria. |
| 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.ClusterNotFound | The instance cannot be found. |
| ResourceNotFound.InstanceNotFound | The instance cannot be found. |
| ResourceNotFound.TKEPreconditionNotFound | The pre-installed components of the TKE cluster are not deployed. |
| ResourceNotFound.TagsNotFound | The specified tag is not found. |
| ResourceUnavailable.ResourceSpecNotDefaultSpec | The current resource specifications do not have the default specifications. |
| ResourcesSoldOut | Resources have been sold out. |
| ResourcesSoldOut.CbsSoldOut | CBS resources have been sold out. |
| ResourcesSoldOut.CvmSoldOut | CVMs have been sold out. |
文档反馈