Last updated: 2021-09-24 17:02:06

    1. API Description

    Domain name for API request:

    Note: The DeleteLiveRecord API is only used to delete the record of recording tasks but not stop recording or deleting an ongoing recording task. If you need to stop a recording task, please use the StopLiveRecord API.

    A maximum of 200 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 parameter. The value used for this API: DeleteLiveRecord.
    Version Yes String Common parameter. The value used for this API: 2018-08-01.
    Region No String Common parameter. This parameter is not required for this API.
    StreamName Yes String Stream name.
    TaskId Yes Integer Task ID returned by the CreateLiveRecord API.

    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 Sample request

    Input Example
    &<Common request parameters>

    Output Example

    "Response": {
      "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"

    5. Developer Resources


    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.AlterTaskState Failed to change the task status.
    InternalError Internal error.
    InternalError.GetConfigError Error getting the configuration.
    InternalError.NetworkError Internal network error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Parameter missing.
    ResourceNotFound.ChannelNotExist The channel does not exist.
    ResourceNotFound.TaskId The TaskId does not exist.