Query Job Run Status via GetJobRun API - E-MapReduce

Get the details 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:GetJobRun

get

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	The ID of the workspace.	w-d2d82aa09151****
jobRunId	string	Yes	The ID of the job run.	jr-93d98d2f7061****

Request parameters

Parameter	Type	Required	Description	Example
regionId	string	No	The region ID. For example, cn-hangzhou represents the Hangzhou region.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The returned data.
jobRun	object	The details of the job.
workspaceId	string	The workspace ID.	w-d2d82aa09155****
jobRunId	string	The job run ID.	jr-93d98d2f7061****
name	string	The name of the job.	jobName
state	string	The state of the job.	Running
stateChangeReason	object	The reason for the state change.
code	string	The error code.	ERR-100000
message	string	The error message.	connection refused
submitTime	integer	The time when the job was submitted.	1684119314000
endTime	integer	The time when the job ended.	1684122914000
codeType	string	The code type of the job. Valid values: SQL JAR PYTHON	SQL
webUI	string	The web UI of the job.	http://spark-ui
executionTimeoutSeconds	integer	The timeout period for the job execution.	3600
resourceOwnerId	string	The UID of the user who creates the job.	150978934701****
tags	array	The tags.
	Tag	A tag.
log	RunLog	The path of the run log.
releaseVersion	string	The Spark engine version.	esr-3.3.1
resourceQueueId	string	The name of the queue on which the job runs.	root_queue
jobDriver	JobDriver	The Spark driver information.
configurationOverrides	object	The Spark configurations of the job.
configurations	array	The configurations.
	Configuration	The configurations.
displayReleaseVersion	string	The version that is displayed in the console.	esr-4.0.0 (Spark 3.5.2, Scala 2.12)
fusion	boolean	Indicates whether to enable the Fusion engine to accelerate the job execution.	false
environmentId	string	The environment ID.	env-cpv569tlhtgndjl8****
notebookAccessUrl	string	The access URL for the notebook of the job run.	http://workflow-ide-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/spark-notebook-output/w-xxxxxxxxx/xxxxxxx
priority	string	The priority of the job run.	5
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "jobRun": {
    "workspaceId": "w-d2d82aa09155****",
    "jobRunId": "jr-93d98d2f7061****",
    "name": "jobName",
    "state": "Running",
    "stateChangeReason": {
      "code": "ERR-100000",
      "message": "connection refused"
    },
    "submitTime": 1684119314000,
    "endTime": 1684122914000,
    "codeType": "SQL",
    "webUI": "http://spark-ui",
    "executionTimeoutSeconds": 3600,
    "resourceOwnerId": "150978934701****",
    "tags": [
      {
        "key": "workflowId",
        "value": "wf-123test"
      }
    ],
    "log": {
      "driverStdOut": "oss://bucket/path/to/stdout",
      "driverStdError": "oss://bucket/path/to/stderr",
      "driverSyslog": "oss://bucket/path/to/syslog",
      "driverStartup": "oss://bucket/path/to/startup"
    },
    "releaseVersion": "esr-3.3.1",
    "resourceQueueId": "root_queue",
    "jobDriver": {
      "sparkSubmit": {
        "entryPoint": "oss://bucket/path/to/entrypoint.jar",
        "entryPointArguments": [
          "arg1"
        ],
        "sparkSubmitParameters": "--conf spark.app.name=test"
      }
    },
    "configurationOverrides": {
      "configurations": [
        {
          "configFileName": "common.conf",
          "configItemKey": "hive.metastore.type",
          "configItemValue": "USER_RDS"
        }
      ]
    },
    "displayReleaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
    "fusion": false,
    "environmentId": "env-cpv569tlhtgndjl8****",
    "notebookAccessUrl": "http://workflow-ide-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/spark-notebook-output/w-xxxxxxxxx/xxxxxxx",
    "priority": "5"
  },
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.