tencent cloud

Feedback

CreateStreamPackageHarvestJob

Last updated: 2023-11-22 16:11:52

    1. API Description

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

    Create HarvestJob.

    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: CreateStreamPackageHarvestJob.
    Version Yes String Common Params. The value used for this API: 2020-05-27.
    Region No String Common Params. This parameter is not required for this API.
    ID Yes String HarvestJob ID, a globally unique identifier.
    ChannelName Yes String The associated channel name.
    EndpointName Yes String The associated endpoint name.
    TimeFormat Yes String Time format, supports the following types: 1. Epoch seconds 2. ISO-8601
    StartTime Yes String Task start time supports two formats for TimeFormat input: 1. Epoch seconds: The input box is a numeric input box, and only positive integers can be entered. 2. ISO-8601: The supported format is ISO time, for example: 2023-08-01T10:00:00+08:00.
    EndTime Yes String Task end time supports two formats for TimeFormat input: 1. Epoch seconds: The input box is a numeric input box, and only positive integers can be entered. 2. ISO-8601: The supported format is ISO time, for example: 2023-08-01T10:00:00+08:00.
    Destination No String The path where the recording file is stored in Cos.
    Manifest No String The file name of the recording file stored in Cos.

    3. Output Parameters

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

    4. Example

    Example1 Example1 Sample request

    Create HarvestJob.

    Input Example

    POST / HTTP/1.1
    Host: mdp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateStreamPackageHarvestJob
    <Common request parameters>
    
    {
        "ID": "your HarvestJob ID",
        "ChannelName": "your package channel name that have startover turned on",
        "EndpointName": "your endpoint name",
        "TimeFormat": "ISO-8601",
        "StartTime": "2023-11-22T14:38:30+08:00",
        "EndTime": "2023-11-22T14:38:30+08:00",
        "Destination": "https://bucket-appid.cos.ap-mumbai.myqcloud.com/",
        "Manifest": "main.m3u8"
    }
    

    Output Example

    {
        "Response": {
            "Info": {
                "ID": "your HarvestJob ID",
                "ChannelName": "your package channel name",
                "EndpointName": "your endpoint name",
                "TimeFormat": "ISO-8601",
                "StartTime": "2023-11-22T14:38:30+08:00",
                "EndTime": "2023-11-22T14:38:30+08:00",
                "Destination": "https://bucket-appid.cos.ap-mumbai.myqcloud.com/",
                "Manifest": "main.m3u8"
            },
            "RequestId": "reqid"
        }
    }
    

    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
    InternalError Internal error.
    InvalidParameter.CacheInfo Invalid CacheInfo value
    InvalidParameter.ExceededQuantityLimit The quantity exceeds the limit.
    InvalidParameter.Name Invalid name.
    InvalidParameter.OutputGroups
    InvalidParameter.Protocol Invalid protocol.
    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