智简魔方文档

开机脚本

开机脚本 API,参数提交方式 POST 公共参数与其他 API 一致

1. 获取开机脚本

URL

/index.php?m=api&a=scriptsListing

请求参数

字段名变量名必填类型描述
搜索内容search否string对开机脚本名称备注内容的搜索
分页数量listpages否int每页显示的数据的数量
排序类型orderby否string用来排序的字段
排序规则sorting否string升序 asc 降序 desc

返回参数

字段名变量名类型描述
开机脚本列表listingarray
id:开机脚本 ID
name:名称
data:脚本内容
remarks:备注
vlan:VLAN 限制
house:支持的机房
house[].id:机房 ID
house[].name:机房名称
house[].auto_install:是否支持自动安装(0:否,1:是)
osname:支持的操作系统名称组成的数组
根据查询条件查询到的所有开机脚本数据
开机脚本总数sumint系统内开机脚本数据的总数
分页数量listpagesint每页显示的数据的数量
搜索类型searchstring搜索类型
搜索内容keystring自定义的搜索内容
排序类型orderbystring用来排序的字段
排序规则sortingstring升序 asc 降序 desc
数据偏移量offsetint返回数据的偏移指针,与分页数量结合使用
状态statusstringsuccess 成功 error 失败

2. 添加开机脚本

URL

/index.php?m=api&a=addScripts

请求参数

字段名变量名必填类型描述
操作系统 IDosid是array支持的操作系统
名称name是string开机脚本名称
脚本内容data是string开机脚本内容
备注remarks是string开机脚本备注
VLAN 限制vlan是stringVLAN 限制,安装了开机脚本插件后必填,格式为 1,2,4-10
机房 IDhouse是array支持的机房 ID 数组,安装了开机脚本插件后必填
支持自动安装的机房 IDauto_install是array支持自动安装的机房 ID 数组,安装了开机脚本插件后必填

返回参数

变量名类型描述
statusstringsuccess 成功 error 失败
msgstring错误信息或提示信息
idint开机脚本 ID

3. 修改开机脚本

URL

/index.php?m=api&a=editScripts

请求参数

字段名变量名必填类型描述
开机脚本 IDid是int开机脚本 ID
操作系统 IDosid是array支持的操作系统
名称name是string开机脚本名称
脚本内容data是string开机脚本内容
备注remarks是string开机脚本备注
VLAN 限制vlan是stringVLAN 限制,安装了开机脚本插件后必填,格式为 1,2,4-10
机房 IDhouse是array支持的机房 ID 数组,安装了开机脚本插件后必填
支持自动安装的机房 IDauto_install是array支持自动安装的机房 ID 数组,安装了开机脚本插件后必填

返回参数

变量名类型描述
statusstringsuccess 成功 error 失败
msgstring错误信息或提示信息

4. 删除开机脚本

URL

/index.php?m=api&a=delScripts

请求参数

字段名变量名必填类型描述
开机脚本 IDid是int开机脚本 ID

返回参数

变量名类型描述
statusstringsuccess 成功 error 失败
msgstring错误信息或提示信息

5. 操作系统获取附加开机脚本

URL

/index.php?m=api&a=getMirrorScripts

请求参数

字段名变量名必填类型描述
服务器 IDid是int当前服务器 ID
操作系统 IDmos是int当前选择的操作系统 ID

返回参数

字段名变量名类型描述
开机脚本列表listingarray
id:开机脚本 ID
name:名称
auto_install:是否支持自动安装(0:否,1:是)
根据当前服务器 ID 和操作系统 ID 查询到的所有开机脚本数据
状态statusstringsuccess 成功 error 失败