指令说明列表 - Equipment.Device_DeviceCommand_GetlistDeviceCommandDesc.Api - 中科图灵开放平台

接口地址：https://api.iot.ink/api/app.php?s=Equipment.Device_DeviceCommand_GetlistDeviceCommandDesc.Api

接口描述：指令说明列表

HTTP/HTTPS

请求协议

GET

请求方式

UTF-8

编码格式

JSON

返回格式

v1.0

版本号

接口参数

参数名字	类型	是否必须	默认值	说明
access_token	字符串	可选		访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口
deviceId	字符串	必须	-	设备id 示例
apiRequestRaw	字符串	可选	-
headerInfo	字符串	可选	-	[]

返回字段

返回结果	类型	说明
ret	整型	状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误
data	对象或混合类型	业务数据，由各自接口指定，通常为对象
data.code	字符串
data.msg	字符串
data.data	数组
data.data>>id	字符串
data.data>>deviceId	字符串
data.data>>deviceModelId	字符串
data.data>>deviceCommandId	字符串
data.data>>aliasName	字符串	指令别名
data.data>>commandDesc	字符串	指令说明
data.data>>createTime	字符串
data.data>>updateTime	字符串
data.data>>commandName	字符串	指令名称
data.data>>deviceModelCommandId	字符串
msg	字符串	提示信息，失败时的错误提示

在线测试

参数	是否必须	值
service	必须
access_token	可选
deviceId	必须
apiRequestRaw	可选
headerInfo	可选

客户端请求示例

成功响应返回示例：
{
    "code": 0,
    "msg": null,
    "data": [
        {
            "id": 11,
            "deviceId": 18280,
            "deviceModelId": 25,
            "deviceCommandId": 42,
            "aliasName": "开门",
            "commandDesc": "开门",
            "createTime": "2021-06-09 17:40:24",
            "updateTime": "2021-06-09 17:41:46",
            "commandName": "DO-1开",
            "deviceModelCommandId": 128
        },
        {
            "id": 12,
            "deviceId": 18280,
            "deviceModelId": 25,
            "deviceCommandId": 43,
            "aliasName": "DO-1关",
            "commandDesc": "",
            "createTime": "2021-06-09 17:40:24",
            "updateTime": "2021-06-09 17:40:24",
            "commandName": "DO-1关",
            "deviceModelCommandId": 129
        }
    ]
}
失败响应返回示例：

错误列表

错误状态码	错误描述信息
400	ret=400，客户端参数错误或非法请求
404	表示接口服务不存在
406	ret=406，access_token令牌校验不通过
407	ret=407，app_key权限不足，或未知应用
408	ret=408，当前用户禁止使用，或用户未登录
409	ret=409，接口流量不足
500	表示服务端内部错误

本文档生成时间：2024-04-19 20:13:44