Domain name for API request: mdp.intl.tencentcloudapi.com.
Create HarvestJob.
A maximum of 20 requests can be initiated per second for this API.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
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. |
Parameter Name | Type | Description |
---|---|---|
Info | HarvestJobResp | HarvestJob information. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Create HarvestJob.
POST / HTTP/1.1
Host: mdp.intl.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"
}
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?