修改设备

功能介绍

修改设备信息

URI

PUT /v2/{project_id}/link/instances/{instance_id}/devices/{device_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。最小长度：0 最大长度：32
instance_id	是	String	实例ID 最小长度：0 最大长度：36
device_id	是	Integer	设备ID 最小值：0 最大值：99999999999999999

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
device_name	是	String	设备名称，支持中文、中文标点符号（）。；，：“”、？《》及英文大小写、数字及英文符号()_,#.?'-@%&!, 长度2-64 最小长度：2 最大长度：64
status	是	Integer	设备状态 0启用 1禁用最小值：0 最大值：10
description	否	String	备注最小长度：0 最大长度：200
tags	否	Array of strings	标签

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
permissions	Array of strings	权限
id	Integer	设备ID 最小值：1 最大值：99999999999999999
parent_device_id	Integer	父设备ID 最小值：1 最大值：99999999999999999
parent_device_name	String	父设备名称最小长度：2 最大长度：64
product	ProductReferer object	产品
device_name	String	设备名称，支持中文、中文标点符号（）。；，：“”、？《》及英文大小写、数字及英文符号()_,#.?'-@%&!, 长度2-64 最小长度：2 最大长度：64
instance_id	String	实例id 最小长度：2 最大长度：64
client_id	String	设备客户端ID，平台生成的设备唯一标识最小长度：0 最大长度：32
node_id	String	设备物理编号，通常使用MAC或者IMEI号，支持英文大小写，数字，下划线和中划线，长度2-64 最小长度：2 最大长度：64
app_name	String	应用名称最小长度：0 最大长度：256
status	Integer	设备状态 0-启用 1-禁用最小值：0 最大值：10
online_status	Integer	是否在线 0-未连接 1-在线 2-离线最小值：0 最大值：10
description	String	备注最小长度：0 最大长度：200
authentication	Authentication object	鉴权
created_user	CreatedUser object	创建时的用户
last_updated_user	LastUpdatedUser object	最后更新时的用户
tags	Array of strings	标签
created_datetime	Long	创建时间，timestamp(ms)，使用UTC时区最小值：1 最大值：99999999999999999
last_updated_datetime	Long	最后修改时间，timestamp(ms)，使用UTC时区最小值：1 最大值：99999999999999999
connect_address	String	设备接入地址最小长度：0 最大长度：200
ssl_connect_address	String	设备接入SSL地址最小长度：0 最大长度：200
ipv6_connect_address	String	设备接入IPV6地址最小长度：0 最大长度：200
ipv6_ssl_connect_address	String	设备接入IPV6 SSL地址最小长度：0 最大长度：200
last_login_datetime	Long	最后登录时间最小值：1 最大值：99999999999999999
node_type	Integer	节点类型 0-直连 1-网关 2-子设备最小值：1 最大值：99999999999999999
device_type	Integer	设备类型0-普通设备（无子设备也无父设备）1-网关设备(可挂载子设备)2-子设备(归属于某个网关设备) 最小值：0 最大值：10
client_ip	String	客户端ip 最小长度：0 最大长度：64
keep_alive	String	心跳时间最小长度：0 最大长度：200
last_active_time	Long	最后登录时间最小值：1 最大值：99999999999999999
version	String	设备版本最小长度：0 最大长度：64
plugin_id	Integer	modbus和opcua设备特有,表示设备所属产品的类型 0-普通产品 1-modbus网关产品 2-opcua网关产品最小值：1 最大值：99999999999999999
app_id	String	应用ID 最小长度：0 最大长度：36

表4 ProductReferer
参数	参数类型	描述
product_id	Integer	产品ID，未填写厂商ID+型号时产品ID必填最小值：1 最大值：99999999999999999
product_name	String	产品名称最小长度：0 最大长度：64
manufacturer_id	String	厂商ID，未填写产品ID时厂商ID和型号必填最小长度：0 最大长度：64
model	String	型号，未填写产品ID时厂商ID和型号必填最小长度：0 最大长度：64
protocol_type	Integer	产品的协议类型：0-mqtt，2-modbus，4-opcua 最小值：0 最大值：10
product_type	Integer	产品类型：0-普通产品 1-网关产品最小值：0 最大值：10

表5 Authentication
参数	参数类型	描述
user_name	String	一型一密/一机一密的用户名最小长度：0 最大长度：64
password	String	一型一密/一机一密的密码，输入要求：至少1个数字，1个大写字母，1个小写字母，1个特殊字符(~!@#$%^&*()-_=+\|[{}];:<>/?)，长度8-32个字符最小长度：0 最大长度：64

表6 CreatedUser
参数	参数类型	描述
user_id	String	用户ID(保留字段,未使用) 最小长度：0 最大长度：64
user_name	String	用户名最小长度：0 最大长度：64

表7 LastUpdatedUser
参数	参数类型	描述
user_id	String	用户ID(保留字段,未使用) 最小长度：0 最大长度：64
user_name	String	用户名最小长度：0 最大长度：64

状态码： 400

表8 响应Body参数
参数	参数类型	描述
error_code	String	系统错误码，针对4xx和5xx类HTTP错误码的详细错误码最小长度：0 最大长度：64
error_msg	String	错误描述最小长度：0 最大长度：200
request_id	String	消息ID 最小长度：0 最大长度：64

状态码： 404

表9 响应Body参数
参数	参数类型	描述
error_code	String	系统错误码，针对4xx和5xx类HTTP错误码的详细错误码最小长度：0 最大长度：64
error_msg	String	错误描述最小长度：0 最大长度：200
request_id	String	消息ID 最小长度：0 最大长度：64

状态码： 500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	系统错误码，针对4xx和5xx类HTTP错误码的详细错误码最小长度：0 最大长度：64
error_msg	String	错误描述最小长度：0 最大长度：200
request_id	String	消息ID 最小长度：0 最大长度：64

请求示例

{
  "device_name" : "device",
  "status" : 0,
  "description" : "device",
  "tags" : [ "tag1", "tag2" ]
}

响应示例

状态码： 200

{
  "permissions" : [ "read", "access", "delete", "modify" ],
  "id" : 711537,
  "parent_device_id" : 711536,
  "parent_device_name" : "parent-device",
  "product" : {
    "product_id" : 116303,
    "product_name" : "p1",
    "manufacturer_id" : "p1",
    "model" : "p1",
    "product_type" : 0,
    "protocol_type" : 0
  },
  "device_name" : "device",
  "instance_id" : "8993a690-cf61-46af-880d-587d823d14e5",
  "client_id" : "D116303711537sGDtK",
  "node_id" : "string",
  "app_name" : "app",
  "status" : 0,
  "online_status" : 2,
  "description" : "device",
  "authentication" : {
    "user_name" : "F01A8D25FE6E4CF5A286B711B31888AE",
    "password" : "************************"
  },
  "created_user" : {
    "user_id" : null,
    "user_name" : "user"
  },
  "last_updated_user" : {
    "user_id" : null,
    "user_name" : "user"
  },
  "tags" : [ ],
  "created_datetime" : 1607408244841,
  "last_updated_datetime" : 1607422571094,
  "connect_address" : "xx.xx.xx.xx",
  "ssl_connect_address" : "xx.xx.xx.xx",
  "ipv6_connect_address" : "xx.xx.xx.xx",
  "ipv6_ssl_connect_address" : "xx.xx.xx.xx",
  "last_login_datetime" : null,
  "node_type" : 0,
  "device_type" : 0,
  "client_ip" : "xx.xx.xx.xx",
  "keep_alive" : 60,
  "last_active_time" : 1608082247010,
  "version" : 4,
  "plugin_id" : 2,
  "app_id" : "cb4b3ec0-8f7f-432f-b05e-fc149d05da5d"
}

状态码： 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-device.update]. Parameter is [deviceOid]. Processor is [path].",
  "requestId" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码： 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.",
  "requestId" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}

状态码： 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

状态码

状态码	描述
200	OK
400	Bad Request
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题：设备管理

上一篇：查询设备详情

下一篇：查询设备主题

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试