Puts a Workflow Execution on hold, suspending all its unexecuted nodes.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClusterId |
string |
Yes |
The ID of the cluster. |
xxljob-d6a5243b6fa |
| AppName |
string |
Yes |
The name of the application. |
xxl-job-executor-sample |
| WorkflowExecutionId |
integer |
Yes |
The ID of the Workflow Execution. |
100 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The root object for the response data. |
||
| RequestId |
string |
The unique ID generated for this request. |
D0DE9C33-992A-580B-89C4-B609A292748D |
| Code |
integer |
The Response Code. |
200 |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| Message |
string |
The Error Message returned if the request fails. |
not support query script history, please upgrade engine version to 2.2.2+ |
Examples
Success response
JSON format
{
"RequestId": "D0DE9C33-992A-580B-89C4-B609A292748D",
"Code": 200,
"Success": true,
"Message": "not support query script history, please upgrade engine version to 2.2.2+"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | Parameter error: %s. | Parameter error: %s |
| 401 | IllegalRequest | IllegalRequest: %s. | Illegal request:%s |
| 500 | InternalError | InternalError: %s. | System Internal Error: %s |
| 403 | NoPermission | No permission to perform this operation: %s. | No permission to perform this operation: %s |
| 404 | NotFound | Not found: %s. | The resource does not exist: %s |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.