Creates a pay-as-you-go or subscription E-MapReduce (EMR) cluster.
Operation description
RunCluster is an upgraded version of CreateCluster and supports more parameters. Parameters of the object and array types are in the JSON format, which are friendly for users who use CLI.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| emr:RunCluster | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. | cn-hangzhou |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfmzabjyop**** |
| PaymentType | string | No | The billing method of the cluster. Valid values:
Default value: PayAsYouGo. | PayAsYouGo |
| SubscriptionConfig | SubscriptionConfig | No | The subscription configurations. This parameter is required only if you set the PaymentType parameter to Subscription. | |
| ClusterType | string | Yes | The type of the cluster. Valid values:
If the first time you create an EMR cluster is after 17:00 (UTC+8) on December 19, 2022, you cannot create a Hadoop, Data Science, Presto, or ZooKeeper cluster. | DATALAKE |
| ReleaseVersion | string | Yes | The EMR version. You can query available EMR versions in the EMR console. | EMR-5.16.0 |
| ClusterName | string | Yes | The cluster name. The name must be 1 to 128 characters in length. The name must start with a letter but cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). | emrtest |
| DeployMode | string | No | The deployment mode of master nodes in the cluster. Valid values:
| HA |
| SecurityMode | string | No | The security mode of the cluster. Valid values:
| NORMAL |
| Applications | array | Yes | The list of services. Number of elements in the array: 1 to 100. | |
| Application | Application | Yes | The service. | |
| ApplicationConfigs | array | No | The service configurations. Number of elements in the array: 1 to 1,000. | |
| ApplicationConfig | ApplicationConfig | No | The service configuration. | |
| NodeAttributes | NodeAttributes | No | The basic attributes of all ECS instances in the cluster. | |
| NodeGroups | array | Yes | The node groups. Number of elements in the array: 1 to 100. | |
| NodeGroupConfig | NodeGroupConfig | Yes | The node group. | |
| BootstrapScripts | array | No | The bootstrap actions. Number of elements in the array: 1 to 10. | |
| Script | Script | No | The bootstrap action. | |
| Tags | array | No | The list of tags. Number of elements in the array: 0 to 20. | |
| Tag | Tag | No | The tag. | |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. The same ClientToken value for multiple calls to the RunCluster operation results in identical responses. Only one cluster can be created by using the same ClientToken value. | A7D960FA-6DBA-5E07-8746-A63E3E4D**** |
| Description | string | No | The cluster description. | Emr cluster for ETL |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 |
| 404 | ResourceNotFound | The resource not found by %s. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. |
| 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. |
For a list of error codes, visit the Service error codes.