ManageTask

1. API Description

Domain name for API request: mps.tencentcloudapi.com.

This API is used to manage initiated tasks.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ManageTask.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
OperationType	Yes	String	Operation type. Valid values: Abort: task termination. Description: If the task type is live stream processing (`LiveStreamProcessTask`), tasks whose task status is `WAITING` or `PROCESSING` can be terminated. For other task types, only tasks whose task status is `WAITING` can be terminated.
TaskId	Yes	String	Video processing task ID.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Terminating specified live stream processing task

Input Example

https://mps.tencentcloudapi.com/?Action=ManageTask
&OperationType=Abort
&TaskId=2459149217-procedure-live-xxx51da009t0
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "335bdaa3-db0e-46ce-9946-51941d9cb0f5"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InvalidParameter	Parameter error.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.InvalidOperationType	Invalid operation type.
InvalidParameterValue.NotProcessingTask	Tasks not in processing status are not supported.
InvalidParameterValue.TaskId	The task ID does not exist.