获取定时任务列表

最近更新时间:2024-11-01 16:30:32

我的收藏

1. 接口描述

接口请求域名:iot.cloud.tencent.com/api/exploreropen/tokenapi。 本接口(AppGetTimerList)用于获取定时器列表。

2. 输入参数

名称
类型
必选
描述
AccessToken
String
公共参数,AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
公共参数,唯一请求 ID,可自行生成,推荐使用 uuid。定位问题时,需提供该次请求的 RequestId。
Action
String
公共参数,本接口取值 AppGetTimerList。
ProductId
String
需要获取定时任务列表的产品 ID。
DeviceName
String
需要获取定时任务列表的设备名称。
Offset
Int
获取的列表偏移量。
Limit
Int
获取到的总消息条数,最大为50。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。
TimerList
Array
获取到的产品列表,请参见 TimerList
Total
Int
总共拥有的条数。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json
{
"RequestId": "req_1",
"Action": "AppGetTimerList",
"ProductId": "US4*****IK",
"DeviceName": "411_3",
"Offset":0,
"Limit":2,
"AccessToken": "c1******************847e"
}
输出示例:成功
{
"Response": {
"RequestId": "req_1",
"Total":2,
"TimerList": [{
"TimerId": "a1c6939b39d345b897**********a12c",
"TimerName": "timer_test_modify",
"ProductId": "US4*****IK",
"DeviceName": "411_3",
"Days": "1100000",
"TimePoint": "09:30",
"Repeat": 0,
"Data": "{\\"brightness\\": 28}",
"Status": 0,
"CreateTime": 1570786578,
"UpdateTime": 1570790807
}, {
"TimerId": "f888dd20c70744939a**********1c3a",
"TimerName": "timer_test",
"ProductId": "US4*****IK",
"DeviceName": "411_3",
"Days": "1000000",
"TimePoint": "07:00",
"Repeat": 1,
"Data": "{\\"brightness\\": 25}",
"Status": 1,
"CreateTime": 1570786483,
"UpdateTime": 1570786483
}]
}
}

5. 错误码

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