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

1. 接口描述

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

用于新增实时上云计划

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddRecordPlan。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,此参数为可选参数。
PlanName String 实时上云计划名称,仅支持中文、英文、数字、_、-,长度不超过32个字符,计划名称全局唯一,不能为空,不能重复
示例值:工作日计划
TemplateId String 实时上云模板ID
示例值:全天模板
LifeCycle LifeCycleData 生命周期
Describe String 上云计划描述,仅支持中文、英文、数字、_、-,长度不超过128个字符
示例值:周一到周五
StreamType String 码流类型,default:不指定码流类型,以设备默认推送类型为主, main:主码流,sub:子码流,其他根据设备能力集自定义,不填按默认类型处理,长度不能超过32个字节
示例值:main
Channels.N Array of ChannelInfo 添加录像的设备的通道信息,一次添加通道总数不超过5000个,包括组织目录下的通道数量
OrganizationId.N Array of String 添加组织目录下所有设备通道,Json数组,可以为空,通道总数量不超过5000个(包括Channel字段的数量)
示例值:10

3. 输出参数

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

4. 示例

示例1 成功

输入示例

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

{
    "PlanName": "name",
    "TemplateId": "48676e89a8c**********baa36220fa4",
    "Describe": "abc",
    "StreamType": "main",
    "Channels": [
        {
            "DeviceId": "48676e89a8c**********baa36220fa4",
            "ChannelId": "9ee325e9984**********a805c19b4e1"
        }
    ],
    "OrganizationId": [
        "10"
    ],
    "LifeCycle": {
        "Transition": 1,
        "Expiration": 60
    }
}

输出示例

{
    "Response": {
        "Data": {
            "PlanId": "88ac5ea6c1f**********24671d0f94f",
            "PlanName": "name",
            "TemplateId": "48676e89a8c**********baa36220fa4",
            "Describe": "abc",
            "StreamType": "main",
            "LifeCycle": {
                "Transition": 1,
                "Expiration": 60
            }
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InvalidParameter.InvalidBodyFormat 无效的消息体格式
InvalidParameter.InvalidChannels 无效的通道参数
InvalidParameter.InvalidOrganizationParam 无效的组织参数
InvalidParameterValue.EmptyChannelId 通道ID不能为空
InvalidParameterValue.EmptyDeviceId 设备ID不能为空
InvalidParameterValue.EmptyName 名称不能为空
InvalidParameterValue.EmptyOrganizationId 组织ID不能为空
InvalidParameterValue.EmptyTemplateId 关联模板不能为空
InvalidParameterValue.IllegalChannelId 通道ID包含了非法字符
InvalidParameterValue.IllegalDescribe 描述中包含不符合要求的字符(仅支持中文、英文、数字、_、-)
InvalidParameterValue.IllegalDeviceId 设备ID包含了非法字符
InvalidParameterValue.IllegalName 名称中包含不符合要求的字符(仅支持中文、英文、数字、_、-)
InvalidParameterValue.IllegalOrganizationId 组织ID包含了非法字符
InvalidParameterValue.IllegalStreamType 码流类型包含非法字符(仅支持英文、数字、_、-)
InvalidParameterValue.InvalidChannelId 无效的通道ID
InvalidParameterValue.InvalidChannelIdOrDeviceId 包含无效的通道ID或者设备ID
InvalidParameterValue.InvalidDeviceId 无效的设备ID
InvalidParameterValue.InvalidTemplateId 无效的模板ID
InvalidParameterValue.OrganizationCountExceedsRange 组织数量不能大于1000个
InvalidParameterValue.PlanChannelsExceedsRange 通道数量一次最多添加5000路
InvalidParameterValue.TooLongDescribe 描述字段过长
InvalidParameterValue.TooLongName 名称过长
InvalidParameterValue.TooLongStreamType 码流类型过长
ResourceInUse.PlanNameRepeat 计划名称不能重复
ResourceNotFound.OrganizationIdNotExist 组织ID不存在
ResourceNotFound.TemplateNotExist 模板不存在