更新时间:2024-09-14 GMT+08:00

取消截图任务

功能介绍

取消已下发截图任务。

只能取消已接受尚在队列中等待处理的任务,已完成或正在执行阶段的任务不能取消。

调用方法

请参见如何调用API

URI

DELETE /v1/{project_id}/thumbnails

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

task_id

String

任务ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Project_Id

String

使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

DELETE https://{endpoint}/v1/{project_id}/thumbnails?task_id=100211

响应示例

状态码: 400

取消已下发截图任务失败。

{
  "error_code" : "MPC.10202",
  "error_msg" : "Invalid request parameter"
}

状态码

状态码

描述

204

取消已下发截图任务成功。

400

取消已下发截图任务失败。

错误码

请参见错误码