取消创建后即将执行的作业或者执行中的作业(已经在通话中的作业取消无效),
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CancelJobs |
系统规定参数。取值:CancelJobs。 |
All | Boolean | 是 | false |
是否取消全部 |
InstanceId | String | 是 | 174952ab-9825-4cc9-a5e2-de82d7fa4cdd |
实例id |
ScenarioId | String | 否 | 9cef0dd3-b9d6-4748-9a6f-77a8c3402bb1 |
过滤条件,作业使用的场景id |
JobGroupId | String | 否 | 9f84892d-721a-4069-9975-668c8164d64e |
过滤条件,作业归属的作业组id |
JobId.N | RepeatList | 否 | edf45790-7200-4cbc-b157-8c0a5f400b75 |
过滤条件,作业id |
JobReferenceId.N | RepeatList | 否 | 4a875676-b136-4087-88b4-de67c61fed69 |
过滤条件,作业的引用id |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | OK |
接口状态码 |
HttpStatusCode | Integer | 200 |
http 状态码 |
Message | String | Success |
接口提示信息 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
请求id |
Success | Boolean | true |
是否成功 |
示例
请求示例
http(s)://[Endpoint]/?Action=CancelJobs
&<公共请求参数>
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&JobGroupId=63cc3b45-feb2-4676-a7d7-f717001fa1e1
正常返回示例
XML
格式
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Success>true</Success>
JSON
格式
{
"RequestId":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"HttpStatusCode":200,
"Code":"OK",
"Success":true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
访问错误中心查看更多错误码。