菜单

编辑设备

编辑设备信息。根据传入的 editType 或字段自动选择更新设备名称、备注、VPS 店铺名或自有设备信息。

基本信息

Path: /modifyDevice

Method: POST

请求参数

参数类型必填说明
editType / actionstring编辑类型。remark 编辑备注,vpsStoreName 编辑 VPS 店铺名,selfEquipment 编辑自有设备,equipment 强制调用自有设备旧编辑接口。不传时默认编辑平台设备名称。
ipIdnumber/string视场景平台设备名称或 VPS 店铺名编辑必填。
deviceId / idnumber/string视场景备注编辑或自有设备编辑时使用的设备记录 ID。
equipmentTypestring设备类型。self 会按自有设备编辑处理。
ipName / deviceName / name / equipmentNamestring视场景设备名称。平台设备名称编辑至少传其中一个。
remarkstring视场景设备备注。传 editType=remark 或只传备注字段时执行备注更新。
idListarray批量编辑平台设备备注的设备 ID 列表。
selfIdListarray批量编辑自有设备备注的设备 ID 列表。
storeNamestring视场景VPS 店铺名。传该字段时按 vpsStoreName 处理。
proxyType / proxyIpAddress / proxyPort / proxyAccount / proxyPasswordstring/number自有设备按需自有设备代理信息,会透传给后端。
vpsIpAddress / vpsPort / vpsAccount / vpsPasswordstring/number自有设备按需自有设备远程信息,会透传给后端。

补充说明

默认场景:不传 editType 且传 ipId 和设备名称时,调用 PUT /api/companyIp/update 更新平台设备名称。

备注场景:传 editType=remark,或只传 remark 且没有名称字段时,调用 POST /api/companyIp/batchUpdateRemark

自有设备场景需要按页面“更新设备”接口字段传完整信息,否则后端可能校验失败。

请求示例

{
  "method": "modifyDevice",
  "ipId": 20001,
  "ipName": "new-device-name"
}

成功返回示例

{
  "method": "modifyDevice",
  "response": {
    "code": 200,
    "msg": "success",
    "data": {
      "ipId": 20001,
      "ipName": "new-device-name"
    }
  }
}

返回字段

字段类型说明
response.codenumber200104001 表示成功。
response.msgstring后端返回提示。
response.dataany后端原始返回数据;如果后端未返回数据,则返回本次提交的关键字段。

失败返回示例

{
  "method": "modifyDevice",
  "status": "error",
  "code": "400",
  "msg": "ipId is required"
}
上一个
新增自有设备
下一个
设备查询
最近修改: 2026-06-03Powered by