Call RunApplicationAction to manage a service - E-MapReduce

Manages a service deployed in a cluster. For example, you can call this operation to start pr stop a service.

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:RunApplicationAction

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	C-C95F0A39D8FF****
ActionName	string	Yes	The name of the action. Valid values: start stop config restart refresh_queues refresh_labels	start
ComponentInstanceSelector	ComponentInstanceSelector	Yes	The operation object.
RollingExecute	boolean	No	Specifies whether to enable rolling execution.	true
ExecuteStrategy	string	No	The execution policy. Valid values: FAILED_BLOCK: The system stops the execution if the execution fails. FAILED_CONTINUE: The system continues the execution if the execution fails.	FAILED_CONTINUE
Interval	integer	No	The interval for rolling execution. Unit: seconds.	10
BatchSize	integer	No	The number of applications in each batch.	1
Description	string	No	The description of the execution.	Execution description

Response elements

Element	Type	Description	Example
	object	The response parameters.
OperationId	string	The operation ID.	op-13c37a77c505****
AbnInstances	array<object>	The abnormal nodes.
	object
NodeName	string	The name of the abnormal node.	core1-1
NodeId	string	The ID of the abnormal node.	i-bp1cudc25w2bfwl5****
RequestId	string	The request ID.	9E3A7161-EB7B-172B-8D18-FFB06BA3****

Examples

Success response

JSON format

{
  "OperationId": "op-13c37a77c505****",
  "AbnInstances": [
    {
      "NodeName": "core1-1",
      "NodeId": "i-bp1cudc25w2bfwl5****"
    }
  ],
  "RequestId": "9E3A7161-EB7B-172B-8D18-FFB06BA3****"
}

Error codes

HTTP status code	Error code	Error message
400	ConcurrentModification	The request on %s failed due to multiple requests to change this object were submitted simultaneously. Wait a few minutes and try again.
400	InvalidParameter.InvalidRunActionScope	The specified run action scope is invalid.
400	MissingParameter.ComponentInstance	You must specify componentInstance.
400	MissingParameter.NodeId	You must specify nodeId.
400	MissingParameter.ComponentName	You must specify componentName.
400	MissingParameter.ApplicationName	You must specify applicationName.
400	MissingParameter.NodeGroupId	You must specify nodeGroupId.
400	InvokeEcmError	An error occurred while invoking ECM service.
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.