ScaleOutInstance

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-08-03 10:40:31

Download PDF

1. API Description

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

This API is used to scale out instance.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: emr.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ScaleOutInstance.
Version	Yes	String	Common parameter. The value used for this API: 2019-01-03.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
TimeUnit	Yes	String	Time unit of scale-out. Valid values: s: seconds. When `PayMode` is 0, `TimeUnit` can only be `s`. m: month. When `PayMode` is 1, `TimeUnit` can only be `m`.
TimeSpan	Yes	Integer	Duration of scale-out, which needs to be used together with `TimeUnit`.
InstanceId	Yes	String	Instance ID.
PayMode	Yes	Integer	Instance billing mode. Valid values: 0: pay-as-you-go.
ClientToken	No	String	Client token.
PreExecutedFileSettings.N	No	Array of PreExecuteFileSettings	Bootstrap script settings.
TaskCount	No	Integer	Number of task nodes added.
CoreCount	No	Integer	Number of core nodes added.
UnNecessaryNodeList.N	No	Array of Integer	Process not required during scale-out.
RouterCount	No	Integer	Number of router nodes added.
SoftDeployInfo.N	No	Array of Integer	Deployed service. `SoftDeployInfo` and `ServiceNodeInfo` are in the same group and mutually exclusive with `UnNecessaryNodeList`. The combination of `SoftDeployInfo` and `ServiceNodeInfo` is recommended.
ServiceNodeInfo.N	No	Array of Integer	Started process.
DisasterRecoverGroupIds.N	No	Array of String	List of spread placement group IDs. Only one can be specified currently.
Tags.N	No	Array of Tag	List of tags bound to added nodes.
HardwareResourceType	No	String	Resource type selected for scaling. Valid values: `host` (general CVM resource), `pod` (resource provided by TKE or EKS cluster)
PodSpec	No	PodSpec	Specified information such as pod specification and source for expansion with pod resources
ClickHouseClusterName	No	String	Machine group name selected for ClickHouse cluster scaling-out
ClickHouseClusterType	No	String	Machine group type selected for ClickHouse cluster scaling-out. new: creates a group; old: selects an existing group
YarnNodeLabel	No	String	YARN node label specified for rule-based scaling-out
PodParameter	No	PodParameter	Custom pod permission and parameter
MasterCount	No	Integer	Number of master nodes to be added When a ClickHouse cluster is scaled, this parameter does not take effect. When a Kafka cluster is scaled, this parameter does not take effect. When `HardwareResourceType` is `pod`, this parameter does not take effect.
StartServiceAfterScaleOut	No	String	Whether to start the service after scaling. `true`: yes; `false`: no

3. Output Parameters

Parameter Name	Type	Description
InstanceId	String	Instance ID.
DealNames	Array of String	Order number. Note: this field may return null, indicating that no valid values can be obtained.
ClientToken	String	Client token. Note: this field may return null, indicating that no valid values can be obtained.
FlowId	Integer	Scaling workflow ID. Note: this field may return null, indicating that no valid values can be obtained.
BillId	String	Big order number. Note: this field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Scaling out a cluster

Input Example

https://emr.tencentcloudapi.com/?Action=ScaleOutInstance
&TimeUnit=s
&TimeSpan=3600
&CoreCount=1
&InstanceId=emr-5n3l5c83
&PayMode=0
&<Common request parameters>

Output Example

{
  "Response": {
    "BillId": "",
    "ClientToken": "",
    "DealNames": [
      "20200309357833",
      "20200309357834",
      "20200309357835",
      "20200309357836"
    ],
    "FlowId": 0,
    "InstanceId": "emr-5n3l5c83",
    "RequestId": "f0f11d21-6d0d-4f73-9177-8ae4ec456068"
  }
}

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.DuplicateOrderNotAllowed	Duplicate order. Please check the EMR console.
InternalError	Internal error.
InternalError.AccountCgwError	An error occurred while calling another service API.
InternalError.CamCgwError	An error occurred while calling another service API.
InternalError.CamError	An error occurred while calling another service API.
InternalError.CbsCgwError	An error occurred while calling another service API.
InternalError.CbsError	An error occurred while calling another service API.
InternalError.CdbCgwError	An error occurred while calling another service API.
InternalError.CdbError	An error occurred while calling another service API.
InternalError.ConfigCgwError	An error occurred while calling another service API.
InternalError.CvmError	An error occurred while calling another service API.
InternalError.KmsError	An error occurred while calling another service API.
InternalError.ProjectCgwError	An error occurred while calling another service API.
InternalError.SgError	An error occurred when calling a security group API.
InternalError.TKEError	An error occurred while calling TKE.
InternalError.TagError	An error occurred while calling another service API.
InternalError.TradeCgwError	An error occurred while calling another service API.
InternalError.VpcCgwError	An error occurred while calling another service API.
InternalError.VpcError	An error occurred while calling another service API.
InternalError.WoodServerError	An error occurred when calling the Woodpecker server.
InvalidParameter	Invalid parameter.
InvalidParameter.InvaildCoreCount	The number of core nodes cannot exceed 20.
InvalidParameter.InvalidAppId	Invalid `AppId`.
InvalidParameter.InvalidClientToken	Invalid `ClientToken`.
InvalidParameter.InvalidClusterId	Invalid parameter: ClusterId.
InvalidParameter.InvalidCount	The number of nodes for scaling-out must be greater than 0.
InvalidParameter.InvalidCountNum	An individual scaling-out request only applies to task nodes or core nodes.
InvalidParameter.InvalidCustomizedPodParam	Container account or container parameter verification error.
InvalidParameter.InvalidEksInstance	Invalid EKS instance.
InvalidParameter.InvalidPaymode	Invalid billing mode.
InvalidParameter.InvalidServiceNodeInfo	The `ServiceNodeInfo` parameter is invalid or incorrect.
InvalidParameter.InvalidSoftDeployInfo	The `InvalidSoftDeployInfo` parameter is invalid or incorrect.
InvalidParameter.InvalidTaskCount	The number of task nodes cannot exceed 20.
InvalidParameter.InvalidTimeSpan	Invalid `timespan`.
InvalidParameter.InvalidTimeUnit	Invalid `TimeUnit`.
InvalidParameter.InvalidTkeInstance	TKE cluster ID is invalid or TKE cluster does not meet the requirements.
InvalidParameterValue.InvalidTkeInstance	The TKE cluster ID is invalid, or the TKE cluster is not eligible.
ResourceInUse.InstanceInProcess	The instance is under workflow.
ResourceNotFound.ClusterNotFound	The instance was not found.
ResourceNotFound.InstanceNotFound	The instance was not found.
ResourceNotFound.TKEPreconditionNotFound	A preset component of the TKE cluster has not been deployed.
ResourceNotFound.TagsNotFound	No specified tag found.
ResourcesSoldOut.	The resources have been sold out.
ResourcesSoldOut.CbsSoldOut	The CBS resources have been sold out.
ResourcesSoldOut.CvmSoldOut	CVM instances have been sold out.

Recent Pages