取消排队中异步任务CancelWaitingAsyncJob的语法及示例_视觉智能开放平台(VIAPI)-阿里云帮助中心

功能描述

通过CancelWaitingAsyncJob可以取消任务状态为QUEUING（排队中）的异步任务，任务状态为PROCESSING（已经开始处理的任务）无法取消。取消后任务状态为JOB_CANCELED（任务取消），已经取消的任务不会再次执行。

说明

您可以进入在线咨询获取在线人工帮助。
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。
本接口只能取消任务状态为QUEUING（排队中）的异步任务，其他状态的任务无法取消。

示例代码

该能力常用语言取消排队中异步任务的示例代码，请参见取消排队中异步任务示例代码。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	CancelWaitingAsyncJob	系统规定参数。取值：CancelWaitingAsyncJob。
JobId	String	是	E75FE679-0303-4DD1-8252-1143B4FA8A27	异步接口返回的RequestId。

返回数据


名称	类型	示例值	描述
RequestId	String	43A0AEB6-45F4-4138-8E89-E1A5D63200E3	请求ID。
Message	String	Cancel job success	返回结果信息。
Success	Boolean	true	是否成功。
HttpCode	String	InvalidParameter	异步任务错误码。

SDK参考

阿里云视觉AI能力推荐使用SDK调用，支持多种编程语言，具体可参见SDK总览。

示例

请求示例

http(s)://viapi.cn-shanghai.aliyuncs.com/?action=CancelWaitingAsyncJob //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&jobId=E75FE679-0303-4DD1-8252-1143B4FA8A27	
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CancelWaitingAsyncJobResponse>
    <RequestId>43A0AEB6-45F4-4138-8E89-E1A5D63200E3</RequestId>
    <Message>Cancel job success</Message>
    <Success>true</Success>
    <HttpCode>InvalidParameter</HttpCode>
</CancelWaitingAsyncJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "43A0AEB6-45F4-4138-8E89-E1A5D63200E3",
  "Message" : "Cancel job success",
  "Success" : true,
  "HttpCode" : "InvalidParameter"
}

错误码

关于取消排队中异步任务的错误码，详情请参见常见错误码。