文档

QueryRecordDownloadJobList

更新时间:
一键部署

调用该接口查询云端录像下载任务的列表。

使用限制

获取到的录像下载地址有效期为1小时。

QPS限制

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

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String QueryRecordDownloadJobList

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

IotInstanceId String iot-2w******

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

PageSize Integer 1

指定返回结果中每页显示的设备数量,最大值是50。

ProductKey String a1Bw******

视频设备所属产品的ProductKey

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

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

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

重要 如果传入该参数,需同时传入ProductKey
IotId String C47T6xwp6ms4bNlkHRWCg4****

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

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

指定从返回结果中的第几页开始显示。默认页数从1开始排序。

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

返回数据

名称

类型

示例值

描述

Code String 400

调用结果状态码:

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

调用成功后,返回的任务列表。

JobList Array of Job

云端录像下载任务的详细信息。

BeginTime Integer 1900000000

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

EndTime Integer 2100000000

查询范围结束时间,格式为10位时间戳,单位为秒。 取值范围为0~2147483647。

FileName String testfile

文件名,Type为1时,显示该参数。

IotId String C47T6xwp6ms4bNlkHRWCg4****

设备ID。

JobErrorCode Integer 9441

任务异常原因,当Status-1时返回异常信息:

  • 9441:网络异常。
  • 9442:音视频数据错误。
JobId String w2s******

任务ID。

Progress Integer 90

录像文件生成进度,范围为0~100。

RecordType Integer 0

录像类型。

  • 0:连续录像。
  • 1:事件录像。
  • 2:主动录像。
  • 4:本地上云录像。
  • 99:混合类型。
Status Integer -1

录像文件的生成状态。

  • -1:录像文件生成异常。
  • 0:录像文件已生成完毕。
  • 1:录像文件正在生成中。
StreamType Integer 0

码流类型。

  • 0:主码流。
  • 1:辅码流。
Type Integer 1

下载类型。

  • 1:按文件下载。
  • 2:设备云端录像按时间范围下载。
  • 3:设备本地录像按时间范围下载。
Url String http://*********

云端录像下载地址,有效期为1小时。

Total Integer 1

任务总数。

ErrorMessage String iot.vision.RequestFailed

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

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

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

Success Boolean true

是否调用成功。

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryRecordDownloadJobList
&IotInstanceId= iot-2w******
&PageSize=1
&IotId=C47T6xwp6ms4bNlkHRWCg4****
&<公共请求参数>

正常返回示例

XML格式

<QueryRecordDownloadJobListResponse>
  <RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
  <Data>
        <Total>1</Total>
        <JobList>
              <Status>-1</Status>
              <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>
              <StreamType>0</StreamType>
              <Type>1</Type>
              <Progress>90</Progress>
              <RecordType>0</RecordType>
              <EndTime>2100000000</EndTime>
              <FileName>testfile</FileName>
              <JobErrorCode>9441</JobErrorCode>
              <BeginTime>1900000000</BeginTime>
              <JobId>w2s******</JobId>
              <Url>http://*********</Url>
        </JobList>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryRecordDownloadJobListResponse>

JSON格式

{
    "RequestId": "E55***B7-4***-4***-8***-D3******F565",
    "Data": {
        "Total": 1,
        "JobList":[ {
            "Status": -1,
            "IotId": "C47T6xwp6ms4bNlkHRWCg4****",
            "StreamType": 0,
            "Type": 1,
            "Progress": 90,
            "RecordType": 0,
            "EndTime": 2100000000,
            "FileName": "testfile",
            "JobErrorCode": 9441,
            "BeginTime": 1900000000,
            "JobId": "w2s******",
            "Url": "http://*********"
        }]
    },
    "Code": 200,
    "Success": true
}

错误码

HttpCode

错误码

错误信息

描述

400 iot.vision.RequestFailed Request failed. 请求失败。
403 iot.lv.requestParamError Request parameter error. 请求参数错误。
403 iot.lv.requestAuthError Request auth error. 认证出错。

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

  • 本页导读 (1)