调用该接口查询云端录像列表。

使用限制

如果在企业版实例中调用该接口，请求参数IotInstanceId必须填写。否则，调用接口会失败。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryRecord

系统规定参数。取值：QueryRecord。
BeginTime Integer 是 1508200012

查询范围开始时间，格式为10位时间戳，单位为秒。
EndTime Integer 是 1582420940

查询范围结束时间，格式为10位时间戳，单位为秒。
IotId String 是 C47T6xwp6ms4bNlkHRWCg4****

摄像头的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。

可调用物联网平台QueryDeviceDetail查询。

StreamType Integer 否 1

码流类型：

  • 0：主码流
  • 1：辅码流

默认值为0。
RecordType Integer 否 1

录像类型：

  • 0：连续录像
  • 1：智能告警事件录像
  • 2：主动录像

默认值为2。

当该参数值置空时，返回全部录像类型。
CurrentPage Integer 否 1

指定从返回结果第几页开始显示，默认值为1。
PageSize Integer 否 10

每页显示的条数。默认值为10，最大值为50。
NeedSnapshot Boolean 否 true

是否需要缩略图。

  • true：需要
  • false：不需要

默认值为false。
IotInstanceId String 否 iot-060a****

实例ID。

  • 企业版实例：必须传入此参数。您可在物联网平台控制台的实例概览页面，查看您的企业版实例ID。
  • 公共实例：无需传入此参数。

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

返回数据

名称 类型 示例值 描述
Code String 200

调用失败时，返回的错误码。更多信息，请参见错误码。

Data Struct

查询结果。
List Array of List

返回的录像列表。
BeginTime String 2018-09-10 00:00:00

录像开始时间。
EndTime String 2018-09-10 00:00:30

录像结束时间。
FileName String file1

录像文件名。
FileSize Integer 204800

录像文件大小，单位为字节。
RecordType Integer 1

录像类型：

  • 0：连续录像
  • 1：智能告警事件录像
  • 2：主动录像
SnapshotUrl String https://*****.jpg

缩略图地址。
StreamType Integer 1

码流类型：

  • 0：主码流
  • 1：辅码流
VideoFrameNumber Integer 1352

录像文件的视频帧数。
Page Integer 1

当前页码。
PageSize Integer 10

每页显示的条数。
ErrorMessage String XXXis mandatory for this action

调用失败时，返回的出错信息。
RequestId String 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1

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

是否调用成功：

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryRecord
&BeginTime=1508200012
&EndTime=1582420940
&IotId=C47T6xwp6ms4bNlkHRWCg4****
&RecordType=3,
&CurrentPage=1,
&PageSize=10,
&NeedSnapshot=true,
&IotInstanceId=iot-060a****,
&<公共请求参数>

正常返回示例

XML格式 

<QueryRecordResponse>
  <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
  <Data>
        <PageSize>10</PageSize>
        <Page>1</Page>
        <List>
              <StreamType>1</StreamType>
              <VideoFrameNumber>1352</VideoFrameNumber>
              <RecordType>1</RecordType>
              <EndTime>2018-09-10 00:00:30</EndTime>
              <SnapshotUrl>https://*****.jpg</SnapshotUrl>
              <FileName>file1</FileName>
              <BeginTime>2018-09-10 00:00:00</BeginTime>
              <FileSize>204800</FileSize>
        </List>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryRecordResponse>

JSON格式 

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": {
        "PageSize": "10",
        "Page": "1",
        "List": [
            {
                "StreamType": "1",
                "VideoFrameNumber": "1352",
                "RecordType": "1",
                "EndTime": "2018-09-10 00:00:30",
                "SnapshotUrl": "https://*****.jpg",
                "FileName": "file1",
                "BeginTime": "2018-09-10 00:00:00",
                "FileSize": "204800"
            }
        ]
    },
    "Code": "200",
    "Success": "true"
}

错误码

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