有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: iss.tencentcloudapi.com 。

用于新增录像上云模板。

该功能本质是拉取设备本地录像数据上云(即存在 IPC 摄像头存储卡或 NVR 硬盘中的录像),操作时需先设定录像时间段(即想要上云的设备本地录像),再设定上云时间段和上云倍速,平台将于上云时间段倍速拉取设备对应前一天的录像时间段数据。

设定需至少满足(上云时间段=前一天的录像时间段/上云倍速),建议上云时间段可多设定10%左右的时间,避免因网络波动导致数据拉取不完整。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddRecordBackupTemplate。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,此参数为可选参数。
TemplateName String 模板名称(仅支持中文、英文、数字、_、-,长度不超过32个字符,模板名称全局唯一,不能为空,不能重复)
示例值:模板1
TimeSections.N Array of RecordTemplateTimeSections 上云时间段(按周进行设置,支持一天设置多个时间段,每个时间段不小于10分钟)
DevTimeSections.N Array of RecordTemplateTimeSections 录像时间段(按周进行设置,支持一天设置多个时间段,每个时间段不小于10分钟)
Scale Integer 上云倍速(支持1,2,4倍速)
示例值:2

3. 输出参数

参数名称 类型 描述
Data AddRecordBackupTemplateData 返回数据
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddRecordBackupTemplate
<公共请求参数>

{
    "TemplateName": "123456",
    "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": "123456",
            "TimeSections": [
                {
                    "DayOfWeek": 4,
                    "EndTime": "02:00:00",
                    "StartTime": "00:00:00"
                }
            ],
            "UpdateAt": "2023-06-21 15:20:35"
        },
        "RequestId": "391dfee3-dff2-445a-a8aa-37c9e9b3d185"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败
InvalidParameterValue 无效的参数值
InvalidParameterValue.BakTimeNotEnough 存在不满足(上云时间段=前一天的录像时间段/上云倍速)的设定,请检查并确认
InvalidParameterValue.DataOutOfRange 周期超出限制(1-7)
InvalidParameterValue.InvalidName 名称为空或填写有误
InvalidParameterValue.InvalidTimeFormat 时间格式错误
InvalidParameterValue.StartOverEndTime 开始时间不能大于结束时间
InvalidParameterValue.TimeLessThanTenMinutes 时间间隔不能小于10分钟
InvalidParameterValue.UnSupportScale 不支持该倍速
ResourceInUse.TemplateNameRepeat 模板名称不能重复