工业魔方API

下发指令

POST

http://ip:port/device/device/command

最后修改时间：2025-01-21 07:48:01

责任人：未设置

调用该接口在一个设备上调用指定服务。

请求参数

Body 参数application/json

devName

string

设备编码

必需

identifier

string

标识符

必需

属性获取固定为“get”;属性设置固定为"set";服务下发为物模型里服务自定义标识符

inputParams

string

入参

必需

JSON格式的字符串描述：

表示数据的JSON字符串，其中属性的获取和设置遵循特定规则。

读写情况下的inputParams结构：

在批量写操作时，使用iot物模型字段标识符作为键，相应的值为欲写入的数值。
例："{"retain":0,"cycle":200,"storage":432,"color":0,"devId":0}"

在批量读操作时，入参为转义后的数组,数组的每一项为数据标识符
"["index1","index2"]"

productKey

string

产品ID

必需

示例

// 写
{
    "productKey": "CP_6t4v1549wzv",
    "devName": "HJD81001000000003",
    "identifier": "set",
    "method": "",
    "inputParams": "{\"retain\":0,\"cycle\":200,\"storage\":432,\"color\":0,\"devId\":0}"
}

// 读
{
    "productKey": "CP_6t4v1549wzv",
    "devName": "HJD81001000000003",
    "identifier": "get",
    "method": "",
    "inputParams": "[\"index1\",\"index2\"]"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://ip:port/device/device/command' \
--header 'Content-Type: application/json' \
--data-raw '// 写
{
    "productKey": "CP_6t4v1549wzv",
    "devName": "HJD81001000000003",
    "identifier": "set",
    "method": "",
    "inputParams": "{\"retain\":0,\"cycle\":200,\"storage\":432,\"color\":0,\"devId\":0}"
}

// 读
{
    "productKey": "CP_6t4v1549wzv",
    "devName": "HJD81001000000003",
    "identifier": "get",
    "method": "",
    "inputParams": "[\"index1\",\"index2\"]"
}'

返回响应

🟢200OK

application/json

Body

code

string

可选

状态码 200：操作成功，300：操作失败，400：未登录，1008：参数异常

data

object

业务数据

可选

fails

array[string]

可选

identifier=set时存在，批量下发多个属性值时失败属性名列表，上游系统可根据此失败属性名列表选择是否进行重试

params

object

可选

identifier=get 时存在，object 对象，key 为 inputParams 传入的属性名，value 为实际值，注意：实际值类型与产品中配置的属性类型强关联，类型动态且不固定。

message

string

可选

消息提示默认操作成功

time

string <date-time>

可选

格式yyyy-MM-dd HH:mm:ss

示例

{
    "code": 0,
    "message": "下发成功",
    "data": {
        "fails": [
            "M1491",
            "M1471",
            "M1481",
            "M1451",
            "M1461",
            "M1431",
            "M1441"
        ]
    }
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

修改于 2025-01-21 07:48:01

HTTP设备数据推送接口

查询产品详情