API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 智能视图计算平台 > 录像计划相关接口 > 新增录像上云计划

新增录像上云计划

最近更新时间：2024-04-22 01:19:13

我的收藏

本页目录：

1. 接口描述

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

用于新增录像上云计划 （当前仅适用于通过GB28181协议和网关接入的设备/视频通道）

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：AddRecordBackupPlan。
Version 是 String 公共参数，本接口取值：2023-05-17。
Region 否 String 公共参数，此参数为可选参数。
TemplateId 是 String 录制模板ID（录像计划关联的模板ID，从查询录像上云模板列表接口ListRecordBackupTemplates中获取）
示例值：584fd9d0-569c-4153-aff7-****
PlanName 是 String 录像计划名称（仅支持中文、英文、数字、_、-，长度不超过32个字符，计划名称全局唯一，不能为空，不能重复）
示例值：录像上云计划1
Describe 是 String 录像计划描述（仅支持中文、英文、数字、_、-，长度不超过128个字符）
示例值：这是计划的一部分
LifeCycle 是 LifeCycleData 生命周期（录像文件生命周期设置，管理文件冷、热存储的时间）
Channels.N 否 Array of ChannelInfo 通道及通道所属设备（添加录像的设备的通道信息，一次添加通道总数不超过5000个，包括组织目录下的通道数量）
OrganizationId.N 否 Array of String 添加组织目录下所有设备通道（Json数组，可以为空，通道总数量不超过5000个（包括Channel字段的数量））
示例值： 237

3. 输出参数

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

4. 示例

示例1 成功

输入示例

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

{
    "TemplateId": "abcdefgh-1234-5678-ijkl-1234567890ab",
    "PlanName": "test-plan-1",
    "Describe": "test1",
    "LifeCycle": {
        "Transition": 7,
        "Expiration": 0
    },
    "OrganizationId": [
        "191"
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "ChannelCount": 0,
            "CreateAt": "2023-06-05 15:11:43",
            "Describe": "test1",
            "LifeCycle": {
                "Expiration": 0,
                "Transition": 7
            },
            "PlanId": "hijklmno-efgh-5678-ijkl-1234567890ab",
            "PlanName": "test-plan-1",
            "Status": 0,
            "TemplateId": "abcdefgh-1234-5678-ijkl-1234567890ab",
            "UpdateAt": "2023-06-05 15:11:43"
        },
        "RequestId": "b00b406c-b891-4ef0-9169-16dc4c51e8a9"
    }
}

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.InvalidChannelId 无效的通道ID
InvalidParameterValue.InvalidDescription 描述填写有误
InvalidParameterValue.InvalidDeviceId 无效的设备ID
InvalidParameterValue.InvalidName 名称为空或填写有误
InvalidParameterValue.InvalidOrganizationId 无效的组织ID
InvalidParameterValue.InvalidTemplateId 无效的模板ID
InvalidParameterValue.PlanNameRepeat 计划名称不能重复
ResourceInUse.PlanNameRepeat 计划名称不能重复
ResourceNotFound 资源不存在
中国站