文档

CreateLocalRecordDownloadByTimeJob

更新时间:
一键部署

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

使用限制

  • 单次按时间下载时长限制:30分钟。
  • 下载任务和文件最多保存时长为1天, 超时后可重新下载。
  • 单实例最多同时支持下载并发限制为10路(下载完成不计入)。
  • 若音视频编码参数发生变化,默认下载的录像为前半段录像。
  • 由于设备上行网络波动可能引起链路异常断开或者设备主动丢数据,上传和下载的录像可能为不完整的录像文件。
  • 下载的录像数据由设备推流逻辑实现决定,若推流数据异常可能出现下载录像时长与任务设置时间段不一致的情况。

QPS限制

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

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateLocalRecordDownloadByTimeJob

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

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
Speed Float 1.0

设备上传倍速。 默认值1.0,取值范围为0.125~8.0

IotId String C47T6xwp6ms4bNlkHRWCg4****

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

重要

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

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

返回数据

名称

类型

示例值

描述

Code String 400

调用结果状态码:

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

调用成功,返回的数据。

JobId String w2s******

任务ID。

ErrorMessage String Download job error.

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

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

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

Success Boolean true

是否调用成功。

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

示例

请求示例

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

正常返回示例

XML格式

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

JSON格式

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

错误码

HttpCode

错误码

错误信息

描述

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. 认证出错。
400 iot.vision.StreamPushFailed Stream push failed. 推流失败。
400 iot.vision.DeviceOffline Device is offline. 设备不在线。

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