AIRIOT API 4.0

根据id更新驱动实例数据

PATCH

/driver/driverInstance/{id}

驱动实例管理

请求参数

Path 参数

string

唯一标识

必需

Header 参数

x-request-project

string

可选

项目ID, 默认default

Authorization

string

Token

可选

默认值:

Body 参数application/json

autoReload

object

自动重载

可选

额外字段

integer | number | string | boolean

可选

createTime

string

可选

驱动实例创建时间，后端自动生成

debug

boolean

可选

TemplateId string json:"TemplateId,omitempty"

示例值:

true

device

object

可选

设备配置，具体字段取决于驱动协议

额外字段

integer | number | string | boolean

可选

disable

boolean

可选

是否禁用驱动 //

示例值:

true

distributed

enum<string>

可选

集群模式下，设备分配方式(all:所有的设备全部分给每个驱动实例,average:所有的设备平均分给每个驱动实例)

枚举值:

allaverage

示例值:

all

driverType

string

驱动类型

必需

示例值:

modbus

groupId

string

驱动实例组唯一标识

可选

示例值:

6507cc51525ddab7a1411cba

string

驱动实例唯一标识

可选

示例值:

6507cc87525ddab7a1411cbc

isDriverTemplate

boolean

是否是驱动模板

可选

示例值:

true

name

string

驱动实例名称

必需

示例值:

modbus驱动

ports

string

可选

server类型驱动暴露的端口号 //

示例值:

0.0.0.0:53342->58588/tcp,9000/tcp

runMode

enum<string>

必需

运行模式(one:单实例,cluster:集群,node:集群节点)

枚举值:

oneclusternode

示例值:

one

state

string

可选

驱动实例对应容器的运行状态

示例值:

running

tables

array[object (entity.TableSchema) {3}]

可选

当前实例处理的设备表信息

device

object (entity.DeviceSchema)

可选

devices

array[object (entity.TableDataSchemaConfig) {5}]

可选

string

可选

template

object

模板配置

可选

额外字段

integer | number | string | boolean

可选

url

string

可选

不存入数据库，供安装驱动实例用

示例值:

https://d.airiot.cn/modbus/v4.2.28/modbus-linux-x86_64.tar.gz

user

allOf {1}

可选

创建驱动实例的所属用户信息

object (entitys.UserSchema)

可选

version

string

驱动实例的当前版本

可选

示例值:

v4.0.1

示例

{
  "autoReload": {},
  "createTime": "string",
  "debug": true,
  "device": {},
  "disable": true,
  "distributed": "all",
  "driverType": "modbus",
  "groupId": "6507cc51525ddab7a1411cba",
  "id": "6507cc87525ddab7a1411cbc",
  "isDriverTemplate": true,
  "name": "modbus驱动",
  "ports": "0.0.0.0:53342->58588/tcp,9000/tcp",
  "runMode": "one",
  "state": "running",
  "tables": [
    {
      "device": {
        "commands": [
          {}
        ],
        "driver": "string",
        "events": [
          {}
        ],
        "groupId": "string",
        "settings": {},
        "tags": [
          {}
        ]
      },
      "devices": [
        {
          "device": {
            "commands": [
              {}
            ],
            "driver": "string",
            "events": [
              {}
            ],
            "groupId": "string",
            "settings": {},
            "tags": [
              {}
            ]
          },
          "disable": true,
          "id": "string",
          "name": "string",
          "off": true
        }
      ],
      "id": "string"
    }
  ],
  "template": {},
  "url": "https://d.airiot.cn/modbus/v4.2.28/modbus-linux-x86_64.tar.gz",
  "user": {
    "adminAccess": true,
    "allPermission": [
      "string"
    ],
    "applicant": "string",
    "binddingtalk": true,
    "bindwechatee": true,
    "checkProof": "string",
    "createTime": "string",
    "custom": {},
    "dashboard": {},
    "dduserid": "string",
    "department": [
      {
        "createTime": "string",
        "dataSetting": [
          {
            "query": {},
            "selectRecord": [
              {
                "id": null,
                "name": "string"
              }
            ],
            "selectType": "string",
            "table": {
              "id": "string",
              "title": "string"
            }
          }
        ],
        "fullName": "string",
        "id": "string",
        "modifyTime": "string",
        "name": "string",
        "parent": null,
        "parentId": "string",
        "userIds": [
          "string"
        ],
        "users": [
          {}
        ]
      }
    ],
    "departmentIds": [
      "string"
    ],
    "diff": "string",
    "disabled": true,
    "email": "string",
    "emailSum": "string",
    "errorLoginTimeouttime": "string",
    "errorLoginTimeouttimeAdmin": "string",
    "examineFinal": "string",
    "examineObj": {},
    "examineStatus": "string",
    "examineType": "string",
    "expireUse": 0,
    "expires": 0,
    "extra": {},
    "highSetting": {},
    "id": "string",
    "identificationNumber": "string",
    "identificationNumberSum": "string",
    "identity": true,
    "industry": "string",
    "isFirstLogin": true,
    "isShare": true,
    "isSuper": true,
    "mainmenu": [
      {}
    ],
    "modifyTime": "string",
    "name": "string",
    "new_password": "string",
    "nickName": "string",
    "noChildDept": true,
    "noChildDeptTableData": true,
    "noOpTimeouttime": "string",
    "noOpTimeouttimeAdmin": "string",
    "oldPwdList": [
      "string"
    ],
    "old_password": "string",
    "onlyNode": true,
    "openName": "string",
    "openid": "string",
    "pageSetting": {},
    "password": "string",
    "password2": "string",
    "passwordSum": "string",
    "permission": [
      "string"
    ],
    "phone": "string",
    "phoneSum": "string",
    "publicKey": "string",
    "pwdExpireConfig": {
      "hasPwdExpire": true,
      "pwdExpire": 0
    },
    "pwdExpireConfigSetting": {},
    "pwdTimeouttime": "string",
    "reason": "string",
    "remark": "string",
    "roles": [
      {
        "applicant": "string",
        "createTime": "string",
        "dashboard": {},
        "description": "string",
        "diff": "string",
        "disabled": true,
        "examineFinal": "string",
        "examineObj": {},
        "examineStatus": "string",
        "examineType": "string",
        "highSetting": {},
        "i18nProp": {},
        "id": "string",
        "isBlackList": true,
        "mainmenu": [
          {}
        ],
        "modifyTime": "string",
        "name": "string",
        "permission": [
          "string"
        ],
        "reason": "string",
        "submitTime": "string",
        "userIds": [
          "string"
        ],
        "users": [
          {}
        ]
      }
    ],
    "rolesIds": [
      "string"
    ],
    "settings": {},
    "shareUserType": "string",
    "showCloseStatus": "string",
    "sleepTimeouttime": "string",
    "startTime": {},
    "status": "string",
    "submitTime": "string",
    "tableDataSetting": [
      {
        "query": {},
        "selectRecord": [
          {
            "id": null,
            "name": "string"
          }
        ],
        "selectType": "string",
        "table": {
          "id": "string",
          "title": "string"
        }
      }
    ],
    "tableFieldsSetting": {},
    "tableSetting": [
      {
        "id": "string",
        "title": "string"
      }
    ],
    "tableSizeSetting": {},
    "timeoutTimeUse": "string",
    "type": "string",
    "warningFilter": [
      {}
    ],
    "wechateeuserid": "string"
  },
  "version": "v4.0.1"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/driver/driverInstance/' \
--header 'Authorization: {{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "autoReload": {},
    "createTime": "string",
    "debug": true,
    "device": {},
    "disable": true,
    "distributed": "all",
    "driverType": "modbus",
    "groupId": "6507cc51525ddab7a1411cba",
    "id": "6507cc87525ddab7a1411cbc",
    "isDriverTemplate": true,
    "name": "modbus驱动",
    "ports": "0.0.0.0:53342->58588/tcp,9000/tcp",
    "runMode": "one",
    "state": "running",
    "tables": [
        {
            "device": {
                "commands": [
                    {}
                ],
                "driver": "string",
                "events": [
                    {}
                ],
                "groupId": "string",
                "settings": {},
                "tags": [
                    {}
                ]
            },
            "devices": [
                {
                    "device": {
                        "commands": [
                            {}
                        ],
                        "driver": "string",
                        "events": [
                            {}
                        ],
                        "groupId": "string",
                        "settings": {},
                        "tags": [
                            {}
                        ]
                    },
                    "disable": true,
                    "id": "string",
                    "name": "string",
                    "off": true
                }
            ],
            "id": "string"
        }
    ],
    "template": {},
    "url": "https://d.airiot.cn/modbus/v4.2.28/modbus-linux-x86_64.tar.gz",
    "user": {
        "adminAccess": true,
        "allPermission": [
            "string"
        ],
        "applicant": "string",
        "binddingtalk": true,
        "bindwechatee": true,
        "checkProof": "string",
        "createTime": "string",
        "custom": {},
        "dashboard": {},
        "dduserid": "string",
        "department": [
            {
                "createTime": "string",
                "dataSetting": [
                    {
                        "query": {},
                        "selectRecord": [
                            {
                                "id": null,
                                "name": "string"
                            }
                        ],
                        "selectType": "string",
                        "table": {
                            "id": "string",
                            "title": "string"
                        }
                    }
                ],
                "fullName": "string",
                "id": "string",
                "modifyTime": "string",
                "name": "string",
                "parent": null,
                "parentId": "string",
                "userIds": [
                    "string"
                ],
                "users": [
                    {}
                ]
            }
        ],
        "departmentIds": [
            "string"
        ],
        "diff": "string",
        "disabled": true,
        "email": "string",
        "emailSum": "string",
        "errorLoginTimeouttime": "string",
        "errorLoginTimeouttimeAdmin": "string",
        "examineFinal": "string",
        "examineObj": {},
        "examineStatus": "string",
        "examineType": "string",
        "expireUse": 0,
        "expires": 0,
        "extra": {},
        "highSetting": {},
        "id": "string",
        "identificationNumber": "string",
        "identificationNumberSum": "string",
        "identity": true,
        "industry": "string",
        "isFirstLogin": true,
        "isShare": true,
        "isSuper": true,
        "mainmenu": [
            {}
        ],
        "modifyTime": "string",
        "name": "string",
        "new_password": "string",
        "nickName": "string",
        "noChildDept": true,
        "noChildDeptTableData": true,
        "noOpTimeouttime": "string",
        "noOpTimeouttimeAdmin": "string",
        "oldPwdList": [
            "string"
        ],
        "old_password": "string",
        "onlyNode": true,
        "openName": "string",
        "openid": "string",
        "pageSetting": {},
        "password": "string",
        "password2": "string",
        "passwordSum": "string",
        "permission": [
            "string"
        ],
        "phone": "string",
        "phoneSum": "string",
        "publicKey": "string",
        "pwdExpireConfig": {
            "hasPwdExpire": true,
            "pwdExpire": 0
        },
        "pwdExpireConfigSetting": {},
        "pwdTimeouttime": "string",
        "reason": "string",
        "remark": "string",
        "roles": [
            {
                "applicant": "string",
                "createTime": "string",
                "dashboard": {},
                "description": "string",
                "diff": "string",
                "disabled": true,
                "examineFinal": "string",
                "examineObj": {},
                "examineStatus": "string",
                "examineType": "string",
                "highSetting": {},
                "i18nProp": {},
                "id": "string",
                "isBlackList": true,
                "mainmenu": [
                    {}
                ],
                "modifyTime": "string",
                "name": "string",
                "permission": [
                    "string"
                ],
                "reason": "string",
                "submitTime": "string",
                "userIds": [
                    "string"
                ],
                "users": [
                    {}
                ]
            }
        ],
        "rolesIds": [
            "string"
        ],
        "settings": {},
        "shareUserType": "string",
        "showCloseStatus": "string",
        "sleepTimeouttime": "string",
        "startTime": {},
        "status": "string",
        "submitTime": "string",
        "tableDataSetting": [
            {
                "query": {},
                "selectRecord": [
                    {
                        "id": null,
                        "name": "string"
                    }
                ],
                "selectType": "string",
                "table": {
                    "id": "string",
                    "title": "string"
                }
            }
        ],
        "tableFieldsSetting": {},
        "tableSetting": [
            {
                "id": "string",
                "title": "string"
            }
        ],
        "tableSizeSetting": {},
        "timeoutTimeUse": "string",
        "type": "string",
        "warningFilter": [
            {}
        ],
        "wechateeuserid": "string"
    },
    "version": "v4.0.1"
}'

返回响应

🟢200成功返回ok

application/json

Body

status

enum<string>

状态(OK)

可选

枚举值:

OKERRORFAIL

示例

{
  "status": "OK"
}

🟠400请求发生错误

🟠401无效令牌或token过期

🔴500服务器发生错误

根据id从数据库删除一条驱动实例数据

根据过滤器查询驱动事件数据