Help Center/ Media Processing Center/ API Reference/ Video Metadata Extraction APIs/ Canceling a Video Parsing Task
Updated on 2025-12-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Canceling a Video Parsing Task

Function

This API is used to cancel a video parsing task. Only tasks in the queue can be canceled.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    mpc:extracTask:delete

    Write

    -

    -

    -

    -

URI

DELETE /v1/{project_id}/extract-metadata

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. (tag:hc,hk)

Project ID. For details about how to obtain the project ID, see [Obtaining a Project ID]. (tag:hcso,g42,cmcc)
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: 204

Video parsing task canceled successfully.

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}/extract-metadata?task_id=100211

Example Responses

Status code: 400

Failed to cancel the video parsing task.

{
  "error_code" : "MPC.10212",
  "error_msg" : "Operation failed."
}

Status Codes

Status Code

Description

204

Video parsing task canceled successfully.

400

Failed to cancel the video parsing task.

Error Codes

See Error Codes.

Parent Topic: Video Metadata Extraction APIs