有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名:iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口(AppListEventHistory)用于获取设备的历史事件。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
公共参数,用户通过微信号、手机或邮箱账号登录成功后,获取的访问 Token。
RequestId
String
公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。
Action
String
AppListEventHistory。
ProductId
String
产品 ID。
DeviceName
String
设备名称。
Type
String
搜索的事件类型:alert 表示告警,fault 表示故障,info 表示信息,为空则表示查询上述所有类型事件。
StartTime
Int64
起始时间(Unix 时间戳,秒级),为0表示当前时间。
EndTime
Int64
结束时间(Unix 时间戳,秒级),为0表示当前时间。
Context
String
搜索上下文,用作查询游标。
Size
Int64
单次获取的历史数据项目的最大数量。
EventId
String
事件标识符,可以用来指定查询特定的事件,如果不指定,则查询所有事件。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数,唯一请求 ID,与入参相同。
Context
String
搜索上下文,用作查询游标。
Total
Int64
搜索结果数量。
Listover
Bool
搜索结果是否已经结束。
EventHistory
Array
搜集结果集。

4. 示例

示例1

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
"AccessToken": "accesstoken***********acc",
"RequestId": "026fe48b-0c31-4a7c-aaf6-83ba3e9s4bcf",
"ProductID": "ABCDE12345",
"DeviceName": "DEV",
"StartTime": 0,
"EndTime": 0,
"Type": "info",
"Size": 5,
"Context": "",
"Action": "AppListEventHistory"
}

输出示例: 成功
{
"Response": {
"ClientToken": "1ee12***********7df703e0d",
"OutputParams": "",
"RequestId": "026fe48b-0c31-4a7c-aaf6-83ba3e9s4bcf",
"Context": "DnF1ZXJ5VGhlbkZld***************SUQ0UWVPZUlMLXI1QnBkbGc=",
"EventHistory": [{
"TimeStamp": 1553484903,
"ProductId": "product1",
"DeviceName": "light3",
"EventId": "status_report",
"Type": "info",
"Data": "{\\"status\\": 0,\\"message\\": \\"test message:11:35:03.288277\\"}"
}],
"Total": 1
}
}


5. 错误码

错误码
描述
InternalError
内部错误。
InvalidParameterValue
参数取值错误
InvalidParameterValue.InvalidAccessToken
Token 无效。