CancelJobs - 取消即将执行或执行中的作业

取消创建后即将执行的作业或者执行中的作业(已经在通话中的作业取消无效)。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
outboundbot:CancelJobscreate
*全部资源
*

请求参数

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

实例 id

174952ab-9825-4cc9-a5e2-de82d7fa4cdd
Allboolean

是否取消全部

false
ScenarioIdstring

过滤条件,作业使用的场景 id

9cef0dd3-b9d6-4748-9a6f-77a8c3402bb1
JobGroupIdstring

过滤条件,作业归属的作业组 id

9f84892d-721a-4069-9975-668c8164d64e
JobIdarray

过滤条件,作业 id

string
JobReferenceIdarray

过滤条件,作业的引用 id

string

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

http 状态码

200
Codestring

接口状态码

OK
Messagestring

接口提示信息

Success
RequestIdstring

请求 id

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Successboolean

是否成功

true

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

变更时间变更内容概要操作
暂无变更历史