OperateHoldWorkflowExecution - 挂起工作流实例

挂起工作流实例,会将工作流中还未执行的节点挂起

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

xxljob-d6a5243b6fa
AppNamestring

应用名称

xxl-job-executor-sample
WorkflowExecutionIdlong

工作流实例 ID

100

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

D0DE9C33-992A-580B-89C4-B609A292748D
Codeinteger

响应码

200
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true
Messagestring

错误信息。

not support query script history, please upgrade engine version to 2.2.2+

示例

正常返回示例

JSON格式

{
  "RequestId": "D0DE9C33-992A-580B-89C4-B609A292748D",
  "Code": 200,
  "Success": true,
  "Message": "not support query script history, please upgrade engine version to 2.2.2+"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterParameter error: %s.参数错误: %s
401IllegalRequestIllegalRequest: %s.非法请求:%s
403NoPermissionNo permission to perform this operation: %s.没有权限去执行该操作:%s
404NotFoundNot found: %s.资源不存在:%s
500InternalErrorInternalError: %s.系统内部错误:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-12-25新增 OpenAPI查看变更详情