Stops a RayJob.
Try it now
Test
RAM authorization
Request syntax
POST /api/v1/workspaces/{workspaceId}/rayJob/{submissionId}/cancel HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspaceId |
string |
No |
The workspace ID. |
w-d2d82aa09155 |
| submissionId |
string |
No |
rayjob ID。 |
rj-k7nm8ahl5te4tg91 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
No parameters required.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| requestId |
string |
The request ID. |
DD6B1B2A-5837-5237-ABE4-FF0C8944 |
| success |
boolean |
Indicates whether the cancellation is successfully triggered. |
true |
Examples
Success response
JSON format
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
"success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.