文档

CreateRecordDownloadByTimeJob

更新时间:
一键部署

调用该接口创建按时间下载云端录像的任务。

使用限制

  • 单次按时间下载时长限制:30分钟。
  • 下载时间精度: 下载时间范围精度在10秒内。例如截取选择下载20秒数据, 可能会出现最多下载了30秒数据的情况。
  • 单次按时间下载录像文件数量限制:100。
  • 下载任务和文件最多保存时长为1天, 超时后可重新下载。
  • 单实例最多同时支持下载并发限制为10路(下载完成不计入)。
  • 若音视频编码参数发生改变,默认下载的录像为前半段录像。
  • 若下载录像时间存在重叠,云端会对数据重叠部分去重。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。

说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateRecordDownloadByTimeJob

系统规定参数。取值:CreateRecordDownloadByTimeJob。

BeginTime Integer 1900000000

开始时间,格式为10位的时间戳,单位为秒。取值范围0~2147483647。

EndTime Integer 2100000000

结束时间,格式为10位的时间戳,单位为秒。取值范围为0~2147483647,必须大于开始时间BeginTime

IotInstanceId String iot-******

实例ID。您可在物联网平台控制台的实例概览页签,查看当前实例的ID。

ProductKey String a1Bw******

视频设备所属产品的ProductKey

您可以在物联网平台控制台产品页面或调用QueryProductList接口,查看当前实例下所有产品的信息。

重要 如果传入该参数,需同时传入DeviceName
DeviceName String Device01

视频设备的设备名称。您可以在物联网平台控制台设备页面,或调用QueryDevice接口查看指定产品下设备的DeviceName

重要 如果传入该参数,需同时传入ProductKey
StreamType Integer 0

码流类型。可选:

  • 0(默认):主码流。
  • 1:辅码流。
RecordType Integer 0

录像类型。可选:

  • 0:连续录像。
  • 1:事件录像。
  • 2:主动录像。
  • 4:本地上云录像。
  • 为空:表示全部录像。
IotId String C47T6xwp6ms4bNlkHRWCg4****

视频设备的设备ID。可调用QueryDeviceDetail接口查询。

重要 IotId作为设备唯一标识符,和ProductKeyDeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKeyDeviceName。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数

返回数据

名称

类型

示例值

描述

Code String 400

调用结果状态码:

  • 调用成功,返回200。
  • 调用失败,返回错误码。详细信息,请参见下文错误码
Data Struct

调用成功,返回的数据。

JobId String w2s******

任务ID。

ErrorMessage String Record not exist.

调用失败时,返回的出错信息。

RequestId String E55***B7-4***-4***-8***-D3******F565

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CreateRecordDownloadByTimeJob
&BeginTime=1900000000
&EndTime=2100000000
&IotInstanceId=iot-******
&IotId=C47T6xwp6ms4bNlkHRWCg4****
&<公共请求参数>

正常返回示例

XML格式

<CreateRecordDownloadByTimeJobResponse>
  <RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
  <Data>
        <JobId>w2s******</JobId>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</CreateRecordDownloadByTimeJobResponse>

JSON格式

{
    "RequestId": "E55***B7-4***-4***-8***-D3******F565",
    "Data": {
        "JobId": "w2s******"
    },
    "Code": 200,
    "Success": true
}

错误码

HttpCode

错误码

错误信息

描述

400 iot.vision.RecordNotExist Record not exist. 录像文件不存在。
400 iot.vision.DownloadJobError Download job error. 下载任务异常。
400 iot.vision.ConcurrencyExceedLimit Concurrency exceed the limit. 并发数超过限额。
403 iot.lv.requestParamError Request parameter error. 请求参数错误。
403 iot.lv.requestAuthError Request auth error. 认证出错。

访问错误中心查看更多错误码。

  • 本页导读 (1)