调用该接口获取支持TCA(trigger/condition/action)配置的设备列表。
路径 | /scene/thing/list |
版本号 | 1.0.6 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
flowType | Int | 是 | 1 | 指定场景规则节点类型,查询适用于该场景的设备。0(表示Trigger。当sceneType为CA时,flowType传0无效。);1(表示Condition);2(表示Action)。 |
pageNum | Int | 是 | 1 | 分页页数,从1开始。 |
pageSize | Int | 是 | 20 | 分页页面大小。最小为 1,最大为200。 |
homeId | String | 是 | 123 | 家的ID,生活物联网平台赋予家的唯一标识符。 |
sceneType | String | 否 | IFTTT | 场景规则类型。可取值为:IFTTT和CA。不填默认为IFTTT。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
家中可以作为场景T、C、A的设备列表。 |
|
total | Long |
设备总数。 |
|
pageNo | Int |
分页页码。 |
|
pageSize | Int |
分页大小。 |
|
data | JSON |
设备列表。 |
|
iotId | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
deviceName | String |
设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。 |
|
productKey | String |
产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
|
nickName | String |
设备的昵称或别名。 |
|
image | String |
产品品类的图标URL。 |
|
status | Int |
设备状态。可取值为0(表示未激活);1(表示在线);3(表示离线);8(表示禁用)。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.6",
"iotToken": "token"
},
"params":{
"flowType":1,
"pageNum":1,
"pageSize":20,
"homeId": "123",
"sceneType": "IFTTT"
}
}
正常返回示例
JSON
格式
{
"id": "b99e4d58-019e-4d3a-96c1-d978ccb6afcc",
"code": 200,
"message": null,
"localizedMsg": null,
"data":{
"total":100,
"pageNo":1,
"pageSize":2,
"data":[
{
"iotId":"abcdefg",
"deviceName":"TestDeviceName",
"productKey":"TestProductKey",
"nickName":"xxx",
"image":"http://www.aliyundoc.com/***.jpg",
"status":1
},
{
"iotId":"abcdxxefg",
"deviceName":"TestDeviceName2",
"productKey":"TestProductKey2",
"nickName":"xxxx",
"image":"http://www.aliyundoc.com/***.jpg",
"status":0
}
]
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}