设备管理

API列表

请求方式	API	描述
GET	/v1.0/osaas/projects/{project_id}/devices	分页查询项目下的设备列表
GET	/v1.0/osaas/rooms/{room_id}/devices	分页查询房屋下的设备列表
GET	/v1.0/osaas/devices/{device_id}	获取设备详情
PUT	/v1.0/osaas/devices/{device_id}/name	修改设备自定义名称
GET	/v1.0/osaas/devices/{device_id}/split-devices	获取拆分子设备列表
PUT	/v1.0/osaas/devices/{device_id}/split-devices	批量修改拆分子设备

分页查询项目下的设备列表

接口描述

调用该接口分页查询项目下的设备列表

接口地址

GET /v1.0/osaas/projects/{project_id}/devices

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
page_no	Integer	URL	页码(page_no>0)(默认1)	否
page_size	Integer	URL	页条数(0<page_size<100)(默认20)	否
device_ids	String[]	URL	设备唯一标识列表	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
page_size	Integer	页条数
devices	Arrays	设备集合

devices参数说明

参数名	类型	说明
device_id	String	设备唯一标识
product_id	String	产品唯一标识
product_name	String	产品名称
category	String	设备类型
category_code	String	设备类型编码
name	String	名称
active_time	Long	激活时间，13 位时间戳
gmt_create	Long	创建时间，13 位时间戳
online	Boolean	在线状态(true:在线;false:离线)
software_version	String	软件版本
product_module	String	产品模型
position	String	位置

请求示例

GET {url}/v1.0/osaas/projects/1160823965053******/devices

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 10,
    "devices": [
      {
        "active_time": 1610278970000,
        "category": "Lamp",
        "category_code": "dj",
        "device_id": "vdevo16102789******",
        "gmt_create": 1610278971070,
        "name": "Switch 1",
        "online": true,
        "position": "Test position",
        "product_id": "uvn******",
        "product_module": "",
        "product_name": "HY",
        "project_id": "125614875324******",
        "room_id": "1341704857710******",
        "software_version": "1.0.0"
      }
    ]
  },
  "success": true,
  "t": 1561381210234
}

响应成失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询房屋下的设备列表

接口描述

调用该接口分页查询房屋下的设备列表

接口地址

GET /v1.0/osaas/rooms/{room_id}/devices

请求参数

参数名	类型	参数类型	说明	是否必需
room_Id	String	URI	房屋唯一标识	是
page_no	Integer	URL	页码(page_no>0)(默认1)	否
page_size	Integer	URL	页条数(0<page_size<100)(默认20)	否
device_ids	String[]	URL	设备唯一标识列表	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
page_size	Integer	页条数
devices	Arrays	设备集合

devices参数说明

参数名	类型	说明
device_id	String	设备唯一标识
product_id	String	产品唯一标识
product_name	String	产品名称
category	String	设备类型
category_code	String	设备类型编码
name	String	名称
active_time	Long	激活时间，13 位时间戳
gmt_create	Long	创建时间，13 位时间戳
online	Boolean	在线状态(true:在线;false:离线)
software_version	String	软件版本
product_module	String	产品模型
position	String	位置

请求示例

 GET /v1.0/osaas/rooms/123******/devices

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 10,
    "devices": [
      {
        "active_time": 1610278970000,
        "category": "Lamp",
        "category_code": "dj",
        "device_id": "vdevo16102789******",
        "gmt_create": 1610278971070,
        "name": "Switch 1",
        "online": true,
        "position": "Test position",
        "product_id": "uvn******",
        "product_module": "",
        "product_name": "HY",
        "project_id": "125614875324******",
        "room_id": "1341704857710******",
        "software_version": "1.0.0"
      }
    ]
  },
  "success": true,
  "t": 1561381210234
}

响应成失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

获取设备详情

接口描述

调用该接口获取设备详情

接口地址

GET /v1.0/osaas/devices/{device_id}

请求参数

参数名	类型	参数类型	说明	是否必需
device_id	String	URI	设备唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
device_id	String	设备唯一标识
product_id	String	产品唯一标识
product_name	String	产品名称
category	String	设备类型
category_code	String	设备类型编码
name	String	名称
active_time	Long	激活时间，13 位时间戳
gmt_create	Long	创建时间，13 位时间戳
online	Boolean	在线状态(true:在线;false:离线)
software_version	String	软件版本
product_module	String	产品模型
position	String	位置
project_id	String	所属项目唯一标识
room_id	String	所属房间唯一标识

请求示例

GET {url}/v1.0/osaas/devices/6c5cc1ce9718d******

响应成功示例

{
  "result": {
      "active_time": 1610278970000,
      "category": "Lamp",
      "category_code": "dj",
      "device_id": "vdevo16102789******",
      "gmt_create": 1610278971070,
      "name": "Switch 1",
      "online": true,
      "position": "Test position",
      "product_id": "uvn******",
      "product_module": "",
      "product_name": "HY",
      "project_id": "125614875324******",
      "room_id": "1341704857710******",
      "software_version": "1.0.0"
  },
  "success": true,
  "t": 1561381210234
}

响应成失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

修改设备自定义名称

接口描述

调用该接口修改设备自定义名称

接口地址

PUT /v1.0/osaas/devices/{device_id}/name

请求参数

参数名	类型	参数类型	说明	是否必需
device_id	String	URI	设备唯一标识	是
name	String	BODY	设备自定义名称	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	返回结果

请求示例

PUT {url}/v1.0/osaas/devices/0082396505314******/name

{
  "name": "设备自定义名称"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应成失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

获取拆分子设备列表

接口描述

调用该接口获取拆分子设备列表

接口地址

GET  /v1.0/osaas/devices/{device_id}/split-devices

请求参数

参数名	类型	参数类型	说明	是否必需
device_id	String	URI	设备唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	List	返回结果

result参数说明

参数名	类型	说明
code	String	功能码
name	String	拆分设备名称

请求示例

GET  {url}/v1.0/osaas/devices/6c5cc1ce9718d/split-devices

响应成功示例

{
    "result": [
        {
            "code": "switch_1",
            "name": "风扇"
        }
    ],
    "success": true,
    "t": 1561381210234
}

响应成失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

批量修改拆分子设备

接口描述

调用该接口批量修改拆分子设备

接口地址

PUT /v1.0/osaas/devices/{device_id}/split-devices

请求参数

参数名	类型	参数类型	说明	是否必需
device_id	String	URI	设备唯一标识	是
split_devices	object	body	拆封设备列表	是

split_devices集合参数说明

参数名	类型	参数类型	说明	是否必需
code	String	body	功能码	是
name	String	body	拆分子设备名称	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	返回结果

请求示例

PUT {url}/v1.0/osaas/devices/vdevo18*****7444/split-devices

{
"split_devices":[
        {
            "code": "switch_1",
            "name": "风扇1"
        },
        {
            "code": "switch_2",
            "name": "主灯"
        },
        {
            "code": "switch_3",
            "name": "台灯"
        },
        {
            "code": "switch_4",
            "name": "场景开关"
        }
 ]
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应成失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误