Query Job Run Status via GetJobRun API - E-MapReduce - Alibaba Cloud - E-MapReduce

Retrieves the details of a Spark job run by calling GetJobRun.

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 workspace ID.	w-d2d82aa09151****
jobRunId	string	Yes	The job run ID.	jr-93d98d2f7061****

Request parameters

Parameter	Type	Required	Description	Example
regionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response data.
jobRun	object	The job run details.
codeType	string	The job code type. Valid values: SQL JAR PYTHON	SQL
configurationOverrides	object	The Spark job configuration.
configurations	array	The configuration list.
	Configuration	The configuration information.
displayReleaseVersion	string	The version displayed in the console.	esr-4.0.0 (Spark 3.5.2, Scala 2.12)
endTime	integer	The job end time. The value is a Unix timestamp in milliseconds.	1684122914000
environmentId	string	The environment ID.	env-cpv569tlhtgndjl8****
executionTimeoutSeconds	integer	The execution timeout period.	3600
fusion	boolean	Specifies whether the Fusion engine acceleration is enabled.	false
jobDriver	JobDriver	The Spark Driver information.
jobRunId	string	The job run ID.	jr-93d98d2f7061****
log	RunLog	The path of the run log.
name	string	The job name.	jobName
notebookAccessUrl	string	The download URL of the NOTEBOOK file. This parameter is returned only if the job type is NOTEBOOK.	http://workflow-ide-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/spark-notebook-output/w-xxxxxxxxx/xxxxxxx
priority	string	The job priority.	5
releaseVersion	string	The Spark DPI engine version used to run the node.	esr-3.3.1
resourceOwnerId	string	The UID of the user who created the job.	150978934701****
resourceQueueId	string	The name of the queue used to run the job.	root_queue
state	string	The job status.	Running
stateChangeReason	object	The reason for the status change.
code	string	The error code.	ERR-100000
message	string	The error message.	connection refused
submitTime	integer	The job submission time. The value is a Unix timestamp in milliseconds.	1684119314000
tags	array	The tag list.
	Tag	The tag.
tokenDetails	array<object>	The details of token consumption.
	object	The details of token consumption.
enableThinking	string	Specifies whether thinking mode is enabled.	true
inputModality	string	The input modality.	-
modelName	string	The model name.	qwen-plus
tokenRange	string	The input token range.	0
tokenSource	string	The token source. Valid values: input and output.	input
tokenUsed	integer	The number of tokens consumed.	10000
totalTokens	integer	The total number of tokens consumed.	10000
webUI	string	The web UI of the job.	http://spark-ui
workspaceId	string	The workspace ID.	w-d2d82aa09155****
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "jobRun": {
    "codeType": "SQL",
    "configurationOverrides": {
      "configurations": [
        {
          "configFileName": "common.conf",
          "configItemKey": "hive.metastore.type",
          "configItemValue": "USER_RDS"
        }
      ]
    },
    "displayReleaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
    "endTime": 1684122914000,
    "environmentId": "env-cpv569tlhtgndjl8****",
    "executionTimeoutSeconds": 3600,
    "fusion": false,
    "jobDriver": {
      "sparkSubmit": {
        "entryPoint": "oss://bucket/path/to/entrypoint.jar",
        "entryPointArguments": [
          "arg1"
        ],
        "sparkSubmitParameters": "--conf spark.app.name=test"
      }
    },
    "jobRunId": "jr-93d98d2f7061****",
    "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"
    },
    "name": "jobName",
    "notebookAccessUrl": "http://workflow-ide-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/spark-notebook-output/w-xxxxxxxxx/xxxxxxx",
    "priority": "5",
    "releaseVersion": "esr-3.3.1",
    "resourceOwnerId": "150978934701****",
    "resourceQueueId": "root_queue",
    "state": "Running",
    "stateChangeReason": {
      "code": "ERR-100000",
      "message": "connection refused"
    },
    "submitTime": 1684119314000,
    "tags": [
      {
        "key": "workflowId",
        "value": "wf-123test"
      }
    ],
    "tokenDetails": [
      {
        "enableThinking": "true",
        "inputModality": "-",
        "modelName": "qwen-plus",
        "tokenRange": "0

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.