获取设备规格属性

更新时间:2023-11-23 06:09:33下载pdf

本文介绍获取设备规格属性的 API。

接口描述

根据设备 ID 获取设备规格属性,包含指令集和状态集。

接口地址

GET: /v1.0/iot-03/devices/{device_id}/specification

请求参数

参数名类型参数位置是否必填说明
device_idStringuritrue设备 ID

返回参数

参数名类型说明
resultFunctionStatusRes

result 说明

参数名类型说明
categoryString产品品类
functionsList指令集
statusList状态集

functions 说明

参数名类型说明
nameString指令名称
descString描述
codeString指令
typeString指令类型
valuesString指令入参范围

status 说明

参数名类型说明
codeString状态码
nameString状态名称
typeString类型
valuesString入参范围

请求示例

GET: /v1.0/iot-03/devices/xxxid/specification

返回示例

{
    "result": {
        "functions": [
            {
                "code": "switch",
                "values": "{}",
                "type": "Boolean",
                "name": "开关",
                "desc": "{}"
            }
        ],
        "category": "dj",
        "status": [
            {
                "code": "switch_led",
                "values": "{}",
                "type": "Boolean",
                "name": "开关"
            }
        ]
    },
    "t": 1591872112140,
    "success": true
}

错误码

参考 错误码