tencent cloud

Feedback

ManageTask

Last updated: 2024-01-02 12:23:01

    1. API Description

    Domain name for API request: vod.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: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    TaskId Yes String Video processing task ID.
    OperationType Yes String Operation type. Valid value:
  • Abort: terminate a task. You can only terminate initiated tasks in WAITING status.
  • SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application 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 Stopping an ongoing live stream processing task

    This example shows you how to stop an ongoing live stream processing task.

    Input Example

    https://vod.tencentcloudapi.com/?Action=ManageTask
    &TaskId=251000333-procedure-c27bdf65ea06646171e714f25f5aac6
    &OperationType=Abort
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "510f4d68-09c9-44a3-ab55-192ff22297c9"
        }
    }
    

    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

    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 Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InvalidOperationType Invalid OperationType.
    InvalidParameterValue.TaskId The task ID does not exist.
    UnauthorizedOperation Unauthorized operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support