Help Center/ Media Processing Center/ API Reference/ Snapshot APIs/ Canceling a Snapshot Task
Updated on 2023-12-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Canceling a Snapshot Task

Function

This API is used to cancel a snapshot task. You can only cancel the queuing snapshot tasks. A snapshot task that has started or completed cannot be canceled.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/thumbnails

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID .
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Project_Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

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

Example Responses

Status code: 400

Failed to cancel the snapshot task.

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

Status Codes

Status Code

Description

204

Snapshot task canceled successfully.

400

Failed to cancel the snapshot task.

Error Codes

See Error Codes.

Parent Topic: Snapshot APIs