查询设备能力列表

更新时间：2022-11-11 03:43:30

本文介绍查询设备能力列表的 API。

接口描述

根据设备 ID 和条件，查询设备能力列表。

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
device_id	String	uri	true	设备 iD
query	CapabilityDefinitionQueryReq	query	false	查询条件

query 说明

参数名	类型	参数位置	是否必填	说明
tags	String		false	能力标签，默认为 standard。可选值：standard、original。

返回参数

参数名	类型	说明
result	CapabilitiesDefinitionResp	设备能力定义信息

result 说明

参数名	类型	说明
capabilities	List	能力定义列表
device_id	String	设备 ID

capabilities 说明

参数名	类型	说明
capability_code	String	标识符 Code
name	String	能力名称
methods	List	操作方法列表
tags	List	标签列表
request	ParameterSchema	下发指令 schema 描述信息
response	ParameterSchema	上报数据的 schema 描述信息

request 说明

参数名	类型	说明
type	String	字段类型。枚举值：string、integer、boolean、array、json、raw
name	String	字段名称
description	String	字段描述

response 说明

参数名	类型	说明
type	String	字段类型。枚举值：string、integer、boolean、array、json、raw
name	String	字段名称
description	String	字段描述

请求示例

GET: /v1.0/iot-03/devices/64***dz/capabilities-definition

返回示例

{
    "result": {
        "capabilities": [
            {
                "request": {
                    "description": "",
                    "type": "boolean",
                    "name": "开关"
                },
                "methods": [
                    "get",
                    "post",
                    "event"
                ],
                "tags": [
                    "standard"
                ],
                "capability_code": "switch_led",
                "response": {
                    "description": "",
                    "type": "boolean",
                    "name": "开关"
                },
                "name": "灯开关"
            }
        ],
        "device_id": "64****dz"
    },
    "t": 1644546985633,
    "success": true
}

错误码

参考错误码。