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

1. 接口描述

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

用于新建取回任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddRecordRetrieveTask。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,此参数为可选参数。
TaskName String 任务名称,仅支持中文、英文、数字、_、-,长度不超过32个字符,模板名称全局唯一,不能为空,不能重复
示例值:task1
StartTime Integer 取回录像的开始时间,UTC秒数,例如:1662114146,开始和结束时间段最长为一天,且不能跨天
示例值:1687688595
EndTime Integer 取回录像的结束时间,UTC秒数,例如:1662114146,开始和结束时间段最长为一天,且不能跨天
示例值:1687692195
Mode Integer 取回模式, 1:极速模式,其他暂不支持
示例值:1
Expiration Integer 取回录像副本有效期,最小为1天,最大为365天
示例值:3
Channels.N Array of ChannelInfo 设备通道,一个任务最多32个设备通道
Describe String 取回任务描述
示例值:task

3. 输出参数

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

4. 示例

示例1 成功

输入示例

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

{
    "TaskName": "name",
    "Describe": "",
    "StartTime": 1687688595,
    "EndTime": 1687692195,
    "Mode": 1,
    "Expiration": 3,
    "Channels": [
        {
            "DeviceId": "64505f15-67b1-****-****-0ad6c8ce6aef",
            "ChannelId": "0001a415-b9c1-****-****-b13cfb96c778"
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "TaskId": "1133f5f9c3**********1c3389527532",
            "TaskName": "name",
            "StartTime": 1687688595,
            "EndTime": 1687692195,
            "Mode": 1,
            "Expiration": 3,
            "Status": 2,
            "Capacity": 0,
            "Describe": ""
        },
        "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.InvalidLifeRuleParam 无效的生命周期参数
InvalidParameterValue.EmptyChannelId 通道ID不能为空
InvalidParameterValue.EmptyDeviceId 设备ID不能为空
InvalidParameterValue.EmptyName 名称不能为空
InvalidParameterValue.IllegalDescribe 描述中包含不符合要求的字符(仅支持中文、英文、数字、_、-)
InvalidParameterValue.IllegalName 名称中包含不符合要求的字符(仅支持中文、英文、数字、_、-)
InvalidParameterValue.InvalidChannelIdOrDeviceId 包含无效的通道ID或者设备ID
InvalidParameterValue.InvalidExpiration 无效的副本有效期,范围是1-365天
InvalidParameterValue.InvalidRetrievalMode 无效的取回模式
InvalidParameterValue.InvalidStartTimeOrEndTime 无效的开始或结束时间
InvalidParameterValue.NonSameDay 时间不能跨天
InvalidParameterValue.RetrieveTaskChannelsExceedsRange 一个取回任务最多添加32个设备通道
InvalidParameterValue.StartTimeGreaterThanOrEqualEndTime 开始时间不能大于等于结束时间
InvalidParameterValue.TooLongDescribe 描述字段过长
InvalidParameterValue.TooLongName 名称过长
MissingParameter.MissingRetrieveTaskParam 缺少取回任务参数
ResourceInUse.RetrieveTaskNameRepeat 取回任务名称不能重复