Domain name for API request: iss.intl.tencentcloudapi.com.
This API is used to create a video recording cloud template.
The feature essentially pulls local device recording data to the cloud (i.e., recordings stored in the IPC camera memory card or NVR hard disk). When operating, first set the recording time period (i.e., the local device recording you want to upload to the cloud), then set the Cloud Upload Time Period and upload speed. The platform will pull the previous day's Time Period Data from the device at the specified speed during the Cloud Upload Time Period.
Set the Cloud Upload Time Period to at least meet (Cloud Upload Time Period = previous day's recording time period / cloud upload speed multiplication). It is advisable to set about 10% more time for the Cloud Upload Time Period to avoid incomplete data retrieval due to network fluctuations.
A maximum of 5 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: AddRecordBackupTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2023-05-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| TemplateName | Yes | String | Template name (supports only Chinese, English, number, _, -, length not exceeding 32 characters. Template name must be globally unique, cannot be empty, and must be unique) |
| TimeSections.N | Yes | Array of RecordTemplateTimeSections | Cloud Upload Time Period (settings can be done by week, supports setting multiple time periods per day, each time period not less than 10 minutes) |
| DevTimeSections.N | Yes | Array of RecordTemplateTimeSections | Recording time period (settings can be done by week, support setting multiple time periods per day, each time period not less than 10 minutes) |
| Scale | Yes | Integer | Speed multiplication for cloud migration (supports 1x, 2x, and 4x) |
| DayOffset | No | Integer | Cycle offset. Default: 1. It means to pull yesterday's video recording to the device. 0 means to pull today's video recording to the device. 3 means to pull the video recording to the device from the day before yesterday. Value range: [0, 90] Default value: 1 |
| Parameter Name | Type | Description |
|---|---|---|
| Data | AddRecordBackupTemplateData | Response data. |
| 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. |
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddRecordBackupTemplate
<Common request parameters>
{
"TemplateName": "Template 361",
"TimeSections": [
{
"DayOfWeek": 4,
"StartTime": "00:00:00",
"EndTime": "02:00:00"
}
],
"DevTimeSections": [
{
"DayOfWeek": 3,
"StartTime": "00:00:00",
"EndTime": "01:00:00"
}
],
"Scale": 1
}{
"Response": {
"Data": {
"CreateAt": "2023-06-21 15:20:35",
"DevTimeSections": [
{
"DayOfWeek": 3,
"EndTime": "01:00:00",
"StartTime": "00:00:00"
}
],
"Scale": 1,
"TemplateId": "abcdefgh-1234-5678-ijkl-1234567890ab",
"TemplateName": "Template 361",
"TimeSections": [
{
"DayOfWeek": 4,
"EndTime": "02:00:00",
"StartTime": "00:00:00"
}
],
"UpdateAt": "2023-06-21 15:20:35"
},
"RequestId": "391dfee3-dff2-445a-a8aa-37c9e9b3d185"
}
}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 |
|---|---|
| FailedOperation | Operation failed |
| InvalidParameterValue | Invalid parameter value |
| InvalidParameterValue.BakTimeNotEnough | Existence of a setting failing to satisfy (Cloud Upload Time Period = previous day's recording time period/cloud upload playback speed). Please check and confirm. |
| InvalidParameterValue.DataOutOfRange | Period exceeds the limit (1-7) |
| InvalidParameterValue.InvalidName | Name is empty or incorrect. |
| InvalidParameterValue.InvalidTimeFormat | Time format error. |
| InvalidParameterValue.StartOverEndTime | Start time cannot be greater than end time. |
| InvalidParameterValue.TimeLessThanTenMinutes | Time interval cannot be less than 10 minutes. |
| InvalidParameterValue.UnSupportScale | Playback speed not supported |
| ResourceInUse.TemplateNameRepeat | Template name must be unique. |
文档反馈