接口说明
该接口用于取消或者删除定时任务（支持批量）。
注意事项：
-
定时任务一经创建，不支持修改，单次任务未执行前可以取消；周期任务在结束时间之前，均可以取消。
-
仅已取消的定时任务支持删除。
-
如周期定时任务执行时所有实例均已退订，则该定时任务将被自动删除。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/task/cancel
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceActionTaskCancelReq
|
InstanceActionTaskCancelReq
|
是
|
instanceActionTaskCancelReq |
|
taskIds
|
<string> array
|
是
|
任务ID数组。可通过查询定时任务接口获取。 |
|
deleteTask
|
boolean
|
否
|
是否删除定时任务。取值范围：
默认值: false。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/task/cancel{
"taskIds":[
"33474a18f9d24de990d16acec643b96b"
]
}返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
InstanceActionTaskBatchCancelResp
|
请求成功时返回的数据。 |
|
instanceActionTaskBatchResult
|
<ActionResult> array
|
实例定时任务批量取消结果集。 |
|
taskId
|
string
|
任务ID。 |
|
result
|
boolean
|
操作是否成功。 |
|
message
|
string
|
失败原因。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
返回码：200
OK
{
"requestId":"reqId-66df3b231d674957a61a60f0e87977f5",
"state":"OK",
"body":{
"instanceActionTaskBatchResult":[
{
"taskId":"2ac1122d1fab429ba7b2628e0dc7cdbc",
"result":true,
"message":null
}
]
}
}