调用该接口查询IPC设备的智能告警事件列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryDeviceEvent |
系统规定参数。取值:QueryDeviceEvent。 |
BeginTime | Long | 是 | 1539507310000 |
查询范围起始时间,格式为13位时间戳,单位为毫秒。 |
EndTime | Long | 是 | 1539607310000 |
查询范围结束时间,格式为13位时间戳,单位为毫秒。 |
ProductKey | String | 否 | a1BwAGV**** |
IPC设备所属产品的ProductKey。 您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。 注意 如果传入该参数,需同时传入DeviceName。
|
DeviceName | String | 否 | camera1 |
IPC设备的设备名称。 您可以在物联网平台控制台的设备页查看DeviceName。 注意 如果传入该参数,需同时传入ProductKey。
|
IotId | String | 否 | zLZyi6aOLyOSHa9hsPyD00**** |
IPC设备的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。 注意 如果传入该参数,则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符,和ProductKey与DeviceName的组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName的组合,则以IotId为准。
|
EventType | Integer | 否 | 0 |
智能告警事件类型:
请在物联网平台控制台,产品详情页面的功能定义页签,查看全部智能告警事件类型。详细信息,请参考查看智能告警事件类型。 |
CurrentPage | Integer | 否 | 1 |
指定从返回结果中的第几页开始显示。页数从1开始排序。 |
PageSize | Integer | 否 | 10 |
每页显示的条数。最小值为1,最大值为50,默认值为10。 |
IotInstanceId | String | 否 | iot-cn-n6w1y**** |
实例ID。 您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。 说明 如果公共实例没有ID值,请参见如何获取实例ID。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 |
接口返回码:
|
Data | Struct |
查询结果。 |
|
List | Array of List |
返回的智能告警事件列表。 |
|
EventData | String | {} |
智能告警事件附加信息。 |
EventDesc | String | 移动侦测 |
智能告警事件描述。 |
EventId | String | ae6b74f1dc7d****85d32c210185967f_16080****9471 |
智能告警事件ID。 |
EventPicId | String | aEtMSm9****ORTFxcGpTbDZ****6eTk0 |
智能告警事件对应的图片ID。 |
EventTime | String | 2020-12-15 20:40:49 |
智能告警事件发生时间。 |
EventType | Integer | 1 |
智能告警事件类型。 |
Page | Integer | 1 |
当前页面号。 |
PageCount | Integer | 1 |
总页数。 |
PageSize | Integer | 10 |
每页显示的记录数。 |
Total | Integer | 2 |
总条数。 |
ErrorMessage | String | request forbidden |
调用失败时,返回的出错信息。 |
RequestId | String | 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
是否调用成功:
|
示例
请求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryDeviceEvent
&BeginTime=1539507310000
&EndTime=1539607310000
&IotId=zLZyi6aOLyOSHa9hsPyD00****
&<公共请求参数>
正常返回示例
XML
格式
<QueryDeviceEventResponse>
<RequestId>1FCB5660-020D-40A5-9313-F4F4F493A41F</RequestId>
<Data>
<PageSize>10</PageSize>
<PageCount>1</PageCount>
<Total>2</Total>
<Page>1</Page>
<List>
<EventDesc>移动侦测</EventDesc>
<EventType>1</EventType>
<EventTime>2020-12-15 20:40:49</EventTime>
<EventId>ae6b74f1dc7d40218****85967f_1608****471</EventId>
<EventPicId>aEtMSm9****ORTFxcGpTbDZ****6eTk0</EventPicId>
<EventData>{}</EventData>
</List>
<List>
<EventDesc>移动侦测</EventDesc>
<EventType>1</EventType>
<EventTime>2020-12-15 20:40:29</EventTime>
<EventId>5650d1cdc****8504520e037b2c_16****9466</EventId>
<EventPicId>adsvtMSm9****ORTFkjfdmskDZ****6eTk0</EventPicId>
<EventData>{}</EventData>
</List>
<Code>200</Code>
<Success>true</Success>
</Data>
</QueryDeviceEventResponse>
JSON
格式
{
"RequestId": "1FCB5660-020D-40A5-9313-F4F4F493A41F",
"Data": {
"PageSize": 10,
"PageCount": 1,
"Total": 2,
"Page": 1,
"List": [
{
"EventDesc": "移动侦测",
"EventType": 1,
"EventTime": "2020-12-15 20:40:49",
"EventId": "ae6b74f1dc7d****d32c210****7f_1608036049471",
"EventPicId": "aEtMSm9****ORTFxcGpTbDZ****6eTk0",
"EventData": "{}"
},
{
"EventDesc": "移动侦测",
"EventType": 1,
"EventTime": "2020-12-15 20:40:29",
"EventId": "5650d1cdc01f41e****0e037****036029466",
"EventPicId": "adsvtMSm9****ORTFkjfdmskDZ****6eTk0",
"EventData": "{}"
}],
"Code": "200",
"Success": true
}
}
错误码
访问错误中心查看更多错误码。