编辑设备信息。根据传入的 editType 或字段自动选择更新设备名称、备注、VPS 店铺名或自有设备信息。
基本信息
Path: /modifyDevice
Method: POST
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
editType / action | string | 否 | 编辑类型。remark 编辑备注,vpsStoreName 编辑 VPS 店铺名,selfEquipment 编辑自有设备,equipment 强制调用自有设备旧编辑接口。不传时默认编辑平台设备名称。 |
ipId | number/string | 视场景 | 平台设备名称或 VPS 店铺名编辑必填。 |
deviceId / id | number/string | 视场景 | 备注编辑或自有设备编辑时使用的设备记录 ID。 |
equipmentType | string | 否 | 设备类型。self 会按自有设备编辑处理。 |
ipName / deviceName / name / equipmentName | string | 视场景 | 设备名称。平台设备名称编辑至少传其中一个。 |
remark | string | 视场景 | 设备备注。传 editType=remark 或只传备注字段时执行备注更新。 |
idList | array | 否 | 批量编辑平台设备备注的设备 ID 列表。 |
selfIdList | array | 否 | 批量编辑自有设备备注的设备 ID 列表。 |
storeName | string | 视场景 | VPS 店铺名。传该字段时按 vpsStoreName 处理。 |
proxyType / proxyIpAddress / proxyPort / proxyAccount / proxyPassword | string/number | 自有设备按需 | 自有设备代理信息,会透传给后端。 |
vpsIpAddress / vpsPort / vpsAccount / vpsPassword | string/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.code | number | 200 或 104001 表示成功。 |
response.msg | string | 后端返回提示。 |
response.data | any | 后端原始返回数据;如果后端未返回数据,则返回本次提交的关键字段。 |
失败返回示例
{
"method": "modifyDevice",
"status": "error",
"code": "400",
"msg": "ipId is required"
}