Monitor Spark Job Executors with ListJobExecutors API - E-MapReduce - Alibaba Cloud - E-MapReduce

Lists the executors of a job.

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-serverless-spark:ListJobExecutors

list

*All Resource

*

None

Request syntax

GET /api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}/executors HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	The workspace ID.	w-d2d82aa09155****
jobRunId	string	Yes	The job run ID.	jr-f09a8fda2396****

Request parameters

Parameter	Type	Required	Description	Example
nextToken	string	No	The token for the next page of results.	2
maxResults	integer	No	The maximum number of records to return in a single request.	20
status	string	No	The executor status.	Dead
executorType	string	No	The executor type.	driver
regionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response schema.
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	The token for the next page of results.	2
maxResults	integer	The maximum number of records returned.	20
totalCount	integer	The total number of records.	200
exexutors	array<object>	The list of executors.
	object	The information about a single executor.
workspaceId	string	The workspace ID.	w-78faee4da118f02e
jobRunId	string	The job run ID.	jr-1fe145df8ade366a
executorId	string	The job executor ID.	1
status	string	The running status of the executor.	Running
hostPort	string	The address of the executor.	21.10.x.x:1201x
rddBlocks	integer	The number of Resilient Distributed Dataset (RDD) blocks managed by the executor.	10
memoryUsed	integer	The memory usage of the executor.	30
diskUsed	integer	The disk usage of the executor.	20
totalCores	integer	The total number of cores for the executor.	4
activeTasks	integer	The total number of active tasks that the executor is running.	10
failedTasks	integer	The total number of failed tasks that the executor has run.	2
completedTasks	integer	The total number of completed tasks that the executor has run.	8
totalTasks	integer	The total number of tasks that the executor has run.	50
totalDuration	integer	The total runtime of the executor.	123
totalGCTime	integer	The total garbage collection (GC) time of the executor.	3
totalInputBytes	integer	The number of bytes of input data for the executor.	1024
totalShuffleRead	integer	The number of bytes read during the shuffle phase by the executor.	2048
totalShuffleWrite	integer	The number of bytes written during the shuffle phase by the executor.	2048
maxMemory	integer	The maximum memory of the executor.	4294967296
addTime	integer	The time when the executor was created.	1760601***
executorType	string	The executor type.	driver

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "2",
  "maxResults": 20,
  "totalCount": 200,
  "exexutors": [
    {
      "workspaceId": "w-78faee4da118f02e",
      "jobRunId": "jr-1fe145df8ade366a",
      "executorId": "1",
      "status": "Running",
      "hostPort": "21.10.x.x:1201x",
      "rddBlocks": 10,
      "memoryUsed": 30,
      "diskUsed": 20,
      "totalCores": 4,
      "activeTasks": 10,
      "failedTasks": 2,
      "completedTasks": 8,
      "totalTasks": 50,
      "totalDuration": 123,
      "totalGCTime": 3,
      "totalInputBytes": 1024,
      "totalShuffleRead": 2048,
      "totalShuffleWrite": 2048,
      "maxMemory": 4294967296,
      "addTime": 0,
      "executorType": "driver"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.