ListRayJob - E-MapReduce - Alibaba Cloud Documentation Center

Lists information about Ray jobs.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 per 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. This is an exact match search.	myrayjob
submitTime	object	No	The time range for job submission.
startTime	integer	No	The start of the time range for job submission. This is a UNIX timestamp in milliseconds.	1780017822000
endTime	integer	No	The end of the time range for job submission. This is a UNIX timestamp in milliseconds.	1780018822000
taskBizId	string	No	The ID of the Data Studio task.	TSK-db8b870d901e443ba0aebba40c923e02

Response elements

Element	Type	Description	Example
	object	The response schema.
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 structure of a Ray job.
submissionId	string	The ID of the Ray job.	rj-uiulpgow9xljimm1
name	string	The name of the Ray job.	testRayJob
status	string	The job status. Submitted: The job is submitted. Pending: The cluster is being created. Running: The job is running. Succeeded: The job is successful. Failed: The job failed. Cancelling: The job is being canceled. Cancelled: The job is canceled. Timeout: The job timed out and was canceled.	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.	1776945399000
startTime	integer	The time when the job started.	1776945499000
endTime	integer	The time when the job ended.	1776945509000
duration	integer	The running time 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, this is the Runtime UI. If the cluster is in the Deleted state, this is the History UI. The History UI is supported only for err-1.2.0 and later versions.	https://emr-ray-gateway.aliyuncs.com?token=xxxxxxxxx
cuHours	number	The number of CUs consumed during the job's running time. This is an estimated value. The final value is subject to the bill.	120
clusterState	string	The status of the corresponding Ray cluster. Deleted: The cluster is deleted. Submitted: The cluster is submitted but has not started creating. Pending: The cluster is being created. Running: The cluster is running.	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.