ListRayJob - E-MapReduce - Alibaba Cloud Documentation Center

Lists Ray job information.

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

none

*All Resource

*

None

Request syntax

GET /api/v1/workspaces/{workspaceId}/rayJob HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	No	The workspace ID.	w-d2d82aa09155

Request parameters

Parameter	Type	Required	Description	Example
pageSize	integer	No	The number of entries to return on each page. Default value: 20.	20
pageNum	integer	No	The page number. Default value: 1.	1
submissionId	string	No	The submission ID of the Ray job.	rj-xxxxxxxxxxx
name	string	No	The name of the Ray job. Exact match is supported.	myrayjob
submitTime	object	No	The submission time range.
startTime	integer	No	The start time of the submission time range. The value is a UNIX timestamp in milliseconds.	1780017822000
endTime	integer	No	The end time of the submission time range. The value is a UNIX timestamp in milliseconds.	1780018822000
taskBizId	string	No	The ID of the data development node.	TSK-db8b870d901e443ba0aebba40c923e02

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944
totalCount	integer	The total number of entries.	200
rayJobs	array<object>	The list of Ray jobs.
	object	The Ray job struct.
submissionId	string	The ID of the Ray job.	rj-uiulpgow9xljimm1
name	string	The name of the Ray job.	testRayJob
status	string	The status of the job. Valid values: Submitted: The job is submitted. Pending: The cluster is being created. Running: The job is running. Succeeded: The job succeeded. Failed: The job failed. Cancelling: The job is being cancelled. Cancelled: The job is cancelled. Timeout: The job is cancelled due to a timeout. Valid values: Submitted : Submitted. Succeeded : Succeeded. Failed : Failed. Timeout : Timeout. Running : Running. Cancelled : Cancelled. Cancelling : Cancelling. Pending : Pending.	Running
resourceQueue	string	The Ray engine version.	err-1.2.0 (Ray 2.55.1, Python 3.12)
submitTime	integer	The time when the job was submitted. The value is a UNIX timestamp in milliseconds.	1776945399000
startTime	integer	The time when the job was started. The value is a UNIX timestamp in milliseconds.	1776945499000
endTime	integer	The time when the job ended. The value is a UNIX timestamp in milliseconds.	1776945509000
duration	integer	The execution duration of the job, in seconds.	3564
creatorName	string	The nickname of the creator.	Alice
dashboardUrl	string	The URL of the Ray cluster dashboard. If the Ray cluster is in the Running state, the URL points to the Runtime UI. If the cluster is in the Deleted state, the URL points to the History UI. The History UI is supported only in err-1.2.0 and later.	https://emr-ray-gateway.aliyuncs.com?token=xxxxxxxxx
cuHours	number	The number of compute units (CUs) consumed during the job runtime. This value is an estimate. The actual value is subject to the bill.	120
clusterState	string	The status of the corresponding Ray cluster. Valid values: Deleted: The cluster is deleted. Submitted: The cluster is submitted but not yet created. Pending: The cluster is being created. Running: The cluster is running. Valid values: Submitted : Submitted. Running : Running. Deleted : Deleted. Pending : Pending.	Running

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
  "totalCount": 200,
  "rayJobs": [
    {
      "submissionId": "rj-uiulpgow9xljimm1",
      "name": "testRayJob",
      "status": "Running",
      "resourceQueue": "err-1.2.0 (Ray 2.55.1, Python 3.12)",
      "submitTime": 1776945399000,
      "startTime": 1776945499000,
      "endTime": 1776945509000,
      "duration": 3564,
      "creatorName": "Alice",
      "dashboardUrl": "https://emr-ray-gateway.aliyuncs.com?token=xxxxxxxxx",
      "cuHours": 120,
      "clusterState": "Running"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.