RunCluster - E-MapReduce - Alibaba Cloud Documentation Center

Creates a pay-as-you-go or subscription cluster.

Operation description

RunCluster is an upgraded version of CreateCluster. It uses HTTPS POST requests and supports larger parameter values. For complex parameters, such as objects and arrays, RunCluster uses the JSON format. This improves compatibility with command-line interface (CLI) tools.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr:RunCluster

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ResourceGroupId	string	No	The resource group ID.	rg-acfmzabjyop****
PaymentType	string	No	The billing method. Valid values: PayAsYouGo: pay-as-you-go. Subscription: subscription. Default value: PayAsYouGo.	PayAsYouGo
SubscriptionConfig	SubscriptionConfig	No	The subscription configurations. This parameter is required if you set PaymentType to Subscription.
ClusterType	string	Yes	The cluster type. Valid values: DATALAKE: new data lake. OLAP: data analytics. DATAFLOW: real-time data stream. DATASERVING: DataService Studio. CUSTOM: custom cluster. HADOOP: legacy data lake. This value is not recommended. Use the new data lake cluster type instead. If you create an EMR cluster for the first time after 17:00 (UTC+8) on December 19, 2022, you cannot select HADOOP, DATA_SCIENCE, PRESTO, or ZOOKEEPER as the cluster type.	DATALAKE
ReleaseVersion	string	Yes	The EMR release version. You can find the EMR release version on the EMR cluster purchase page.	EMR-5.16.0
ClusterName	string	Yes	The cluster name. The name must be 1 to 128 characters in length. It must start with a letter or a Chinese character. It cannot start with http:// or https://. It can contain Chinese characters, letters, digits, colons (:), underscores (_), periods (.), or hyphens (-).	emrtest
DeployMode	string	No	The deployment mode of applications in the cluster. Valid values: NORMAL (default): non-high availability deployment. The cluster has one master node. HA: high availability (HA) deployment. This deployment mode requires at least three master nodes.	HA
SecurityMode	string	No	The Kerberos security mode of the cluster. Valid values: NORMAL (default): normal mode. Kerberos is disabled. KERBEROS: Kerberos mode. Kerberos is enabled.	NORMAL
Applications	array	Yes	The list of applications. The number of array elements N can range from 1 to 100.
	Application	No	The application.
ApplicationConfigs	array	No	The application configurations. The number of array elements N can range from 1 to 1000.
	ApplicationConfig	No	The application configuration.
NodeAttributes	NodeAttributes	No	The node attributes. These are the basic attributes of all ECS nodes in the cluster.
NodeGroups	array	Yes	The array of node group configurations. The number of array elements N can range from 1 to 100.
	NodeGroupConfig	No	The node group configuration.
BootstrapScripts	array	No	The array of bootstrap scripts. The number of array elements N can range from 1 to 10.
	Script	No	The bootstrap script.
Tags	array	No	The tags. The number of array elements N can range from 0 to 20.
	Tag	No	The tag.
ClientToken	string	No	A client token to ensure the idempotence of the request. Multiple calls with the same client token return the same result and create only one cluster.	A7D960FA-6DBA-5E07-8746-A63E3E4D****
Description	string	No	The description of the cluster.	Emr cluster for ETL
DeletionProtection	boolean	No	Specifies whether to enable deletion protection for the cluster. Valid values: true: Enables deletion protection. false: Disables deletion protection. Default value: false.	false
Promotions	array	No
	Promotion	No

Response elements

Element	Type	Description	Example
	object	Response schema
ClusterId	string	The cluster ID.	c-b933c5aac7f7***
OperationId	string	The operation ID.	op-13c37a77c505****
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "ClusterId": "c-b933c5aac7f7***",
  "OperationId": "op-13c37a77c505****",
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

HTTP status code	Error code	Error message
400	OperationDenied	The operation is invalid. %s
400	OutOfStock	The requested resource is sold out in the specified zone, try other types of resources or other regions and zones.
400	QuotaExceeded	Request fail due to quota exceed. %s
400	AccountException	Account exception. %s
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.