QueryRecord
调用该接口查询云端录像列表,包括录像基本信息:录像文件名、录像文件大小、录像类型以及录像开始、结束时间等。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为250。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | QueryRecord | 系统规定参数。取值:QueryRecord。 |
BeginTime | Integer | 是 | 1508200012 | 查询范围开始时间,格式为10位时间戳,单位为秒。 |
EndTime | Integer | 是 | 1582420940 | 查询范围结束时间,格式为10位时间戳,单位为秒。 |
ProductKey | String | 否 | a1BwAGV**** | IPC设备所属产品的ProductKey。 您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。 重要 如果传入该参数,需同时传入DeviceName。
|
DeviceName | String | 否 | camera1 | IPC设备的设备名称。 您可以在物联网平台控制台的设备页查看DeviceName。 重要 如果传入该参数,需同时传入ProductKey。
|
IotId | String | 否 | C47T6xwp6ms4bNlkHRWCg4**** | IPC设备的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。 重要 如果传入该参数,则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符,和ProductKey与DeviceName的组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName的组合,则以IotId为准。
|
StreamType | Integer | 否 | 1 | 码流类型:
|
RecordType | Integer | 否 | 1 | 录像类型:
当该参数值置空时,返回全部录像类型。 |
CurrentPage | Integer | 否 | 1 | 指定从返回结果第几页开始显示,默认值为1。 |
PageSize | Integer | 否 | 10 | 每页显示的条数。默认值为10,最大值为50。 |
NeedSnapshot | Boolean | 否 | true | 是否需要缩略图:
|
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 | 录像结束时间。 |
EventType | Integer | 1 | 录像类型(RecordType)为智能告警事件录像时返回该参数,表示录像对应的事件类型。 例如:1表示移动侦测事件。 |
FileName | String | file1 | 录像文件名。 |
FileSize | Integer | 204800 | 录像文件大小,单位为字节。 |
RecordType | Integer | 1 | 录像类型:
|
SnapshotUrl | String | https://lin****/****2Cq_90 | 缩略图地址。 |
StreamType | Integer | 1 | 码流类型:
|
VideoFrameNumber | Integer | 1352 | 录像文件的视频帧数。 |
Page | Integer | 1 | 当前页码。 |
PageSize | Integer | 10 | 每页显示的条数。 |
ErrorMessage | String | tenant auth error. | 调用失败时,返回的出错信息。 |
RequestId | String | 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1 | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功:
|
示例
请求示例
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>
<EventType>1</EventType>
<VideoFrameNumber>1352</VideoFrameNumber>
<RecordType>1</RecordType>
<EndTime>2018-09-10 00:00:30</EndTime>
<SnapshotUrl>https://lin****/****2Cq_90</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,
"EventType":1,
"VideoFrameNumber": 1352,
"RecordType": 1,
"EndTime": "2018-09-10 00:00:30",
"SnapshotUrl": "https://lin****/****2Cq_90",
"FileName": "file1",
"BeginTime": "2018-09-10 00:00:00",
"FileSize": 204800
}
]
},
"Code": "200",
"Success": true
}
错误码
访问错误中心查看更多错误码。