DCIM
产品简介
DCIM手册
DCIM Backend API
DCIM 代理商面板
产品简介
DCIM手册
DCIM Backend API
DCIM 代理商面板
4. 会话管理(REST)
复制页面
用户入口
工单
工单列表
创建工单
认证
用户登录
管理员登录
API认证
系统
系统更新
检查系统更新
获取更新日志
系统API管理
获取系统API列表
创建系统API
修改系统API
删除系统API
获取公共系统配置
服务器
服务器管理
自定义字段
获取服务器自定义字段
创建服务器自定义字段
修改服务器自定义字段
删除服务器自定义字段
添加服务器
获取服务器详情
编辑服务器
删除服务器
空闲服务器IP段
自动分配MAC地址
控制服务器电源
修改服务器备注
获取服务器日志
获取服务器电源状态
获取服务器监控信息详情
获取服务器交付信息
开启服务器DHCP
服务器列表Excel导出
服务器列表Excel导出下载
服务器IP地址
IPv6
自动批量分配IPv6段
生成指定数量的IPv6地址
空闲ipv6
批量分配IPV6段
获取服务器IPv6地址列表
IPv4
空闲ip
设置主ip
分配IPV4段
获取服务器IPv4地址列表
分配ip
获取服务器IP地址块
获取IP段列表
获取IP地址列表
服务器硬件
服务器硬件管理
发送真实硬件获取脚本
获取服务器真实硬件历史
获取服务器真实硬件历史详情
获取服务器硬件列表
分配服务器硬件
移除服务器硬件
返修服务器硬件
获取批次类型
获取硬件类型
获取批次采购时间
获取批次硬件
获取机柜服务器列表
服务器分配
取消分配api
取消分配服务器给用户
获取服务器分配列表
获取服务器分配列表
获取用户服务器下拉列表
分配服务器给用户
服务器规格
分配规格
取消规格
规格分配服务器
服务器交换机端口
修改交换机端口
修改交换机端口 - QoS
修改交换机端口 - VLAN
获取交换机端口
服务器重装
镜像列表
服务器重装系统
获取重装系统镜像列表
获取镜像预设分区
重置服务器操作系统管理员密码
服务器故障
服务器故障
服务器网卡管理
获取服务器网卡列表
服务器网卡添加
服务器网卡修改
服务器网卡删除
服务器杂项接口
获取服务器可用的IP地址列表
获取可用的网关设备
获取服务器网关设备绑定的自定义脚本
执行服务器网关设备绑定的自定义脚本
绑定服务器网卡
获取服务器网卡获取端口vlan
统计服务器电源功耗数据
获取服务器被攻击事件
服务器IPMI
检测服务器KVM类型
获取服务器mac地址
获取服务器IPMI控制台
关闭服务器IPMI控制台
检查vnc连接
获取服务器在线的会话
发送键盘操作到IPMI控制台
服务器电源控制
重置服务器BMC
启动救援模式
修改服务器hostname
取消服务器下所有关联
设置服务器主端口开关
设置服务器下一次启动顺序
设置服务器从在线ISO启动
获取服务器KVM文件
获取IPMI用户列表
添加IPMI用户
修改IPMI用户状态
修改IPMI用户密码
IPMI在线检测
删除IPMI用户
服务器简单锁定
修改简单锁定
删除简单锁定
增加简单锁定
获取简单锁定状态
服务器流量计费
获取流量计费列表
添加流量计费
修改流量计费
删除流量计费中的服务器
关联添加流量计费
关联修改流量计 费
指定流量包列表
添加流量包
删除流量包
获取流量池列表
删除流量池
服务器预下架
创建服务器预下架请求
删除服务器预下架请求
获取服务器预下架请求
服务器任务
获取服务器任务进度
取消服务器任务
服务器VNC
1. 创建会话(REST)
创建服务器 VNC 会话(IPMI KVM)
创建服务器 SSH 会话
创建交换机 SSH 会话
2. 会话共享与页面嵌入(REST + URL 规则)
生成会话共享凭证
[页面 URL] 免登录控制台页面(iframe 嵌入 / 新窗口打开)
3. 实时通道(WebSocket · 原理说明)
[WSS] 直连被控节点实时通道
[WSS] 主控反代实时通道
4. 会话管理(REST)
关闭服务器控制台会话
DELETE
查询会话在线用户
GET
控制台连接诊断
GET
5. 辅助能力(REST)
向会话模拟键盘输入
设置在线 ISO 引导
通过序列号获取服务器信息
GET
获取服务器列表
GET
获取交付服务器通知内容
GET
服务器交付通知
GET
获取服务器端口
GET
数据源
数据源回调处理
管理员
管理员
获取管理员列表
获取管理员详情
修改管理员信息
添 加管理员
删除管理员
获取管理员列表(简化版)
上传管理员头像
获取当前会话权限
获取当前管理员信息
修改当前管理员信息
获取当前管理员OTP二维码
绑定当前管理员OTP
解除绑定当前管理员OTP
获取指定管理员OTP二维码
绑定指定管理员OTP
解除绑定指定管理员OTP
授权
获取授权模块信息
获取机器码
检查授权证书更新
更改授权证书
获取本地授权信息
更新授权证书
使用文件上传更新授权证书
使用序列号更新授权证书
数据中心
数据中心
添加数据中心
获取数据中心列表
修改数据中心
获取数据中心详情
删除数据中心
获取仪表板数据中心列表
获取数据中心机柜列表
获取数据中心能耗带宽图表
获取数据中心下的交换机
获取数据中心选项
机柜
机柜
添加机柜
获取机柜列表
编辑机柜
获取机柜详情
删除机柜
获取机柜空间
获取机柜中的交换机
统计机柜电源功耗数据
解除锁定
获取指定数据中心的机柜列表
获取机柜图片列表
上传机柜图片
获取机柜图片
会话
删除会话
查看会话
用户
用户管理 - OTP
获取二维码信息
绑定otp
解除绑定otp
获取二维码信息
绑定otp
解除绑定otp
用户管理 - API
用户 API 列表
创建用户 API
修改用户 API
删除用户 API
用户管理
用户列表
添加用户
获取用户详情
编辑用户
删除用户
关键字搜索用户
用户下拉列表
用户服务器列表
用户IP地址列表
用户IP地址列表
用户IP地址列表
用户组管理
创建用户组
用户组列表
创建管理员组
管理员列表
User用户组列表
编辑用户组
删除用户组
编辑管理员组
删除管理员组
用户组详情
管理员用户组列表
获取组通知权限内容
修改组通知权限内容
获取个人通知权限内容
修改个人通知权限内容
获取SSH Key
添加SSH Key
文件
获取文件哈希
下载文件
网络安全
获取可用数据源模块
获取数据源远程数据
数据源列表
创建数据源
获取安全事件列表
创建安全事件
标记安全事件完成
删除安全事件
获取安全概览信息
获取按IP地址排名
获取按IP段排名
获取轮询数据源类型
测试轮询数据源连接
获取轮询数据源列表
创建轮询数据源
更新轮询数据源
删除轮询数据源
获取轮询数据源下的MO列表
迁移MO IP
获取轮询数据源下的访问列表
获取轮询数据源下的告警列表
日志管理
获取操作日志列表
获取登录日志列表
获取特定模型操作日志
记录操作日志
控制台
获取会话命令日志
获取会话连接日志
被控管理
被控管理
获取被控设备列表
添加被控设备
编辑被控设备
删除被控设备
获取单个被控设备
检查被控设备版本
请求被控设备下载新版本
请求被控设备应用新版本
获取被控设备当前负载
获取被控设备历史负载
获取被控设备选择列表
检查主机是否在线
获取VNC令牌
清理镜像缓存
工单
工单状态管理
获取工单状态列表
添加工单状态
编辑工单状态
删除工单状态
工单管理
获取工单详情
删除工单
获取工单列表
创建工单
快速编辑工单状态
工单回复管理
获取工单部门列表
获取工单部门下的管理员
查看工单回复信息
增加工单回复
修改工单回复
消息分类管理
获取消息分类列表
创建消息分类
编辑消息分类
删除消息分类
分类信息管理
获取分类信息列表
创建分类信息
编辑分类信息
删除分类信息
工单部门管理
工单部门
添加工单部门
获取工单部门列表
编辑工单部门
删除工单部门
自定义字段
获取自定义字段
创建自定义字段
修改自定义字段
删除自定义字段
获取类型列表
获取类型参数
镜像
镜像管理
镜像列表
添加镜像
远程下载镜像
镜像详情
修改镜像
删除镜像
获取存储镜像文件名列表
上传镜像
获取镜像选项
删除被控上缓存的镜像源文件
获取公开镜像列表
同步文件
获取下载进度
镜像分区方案
获取镜像分区方案列表
添加镜像分区方案
获取镜像分区方案详情
修改镜像分区方案
删除镜像分区方案
根据镜像获取分区方案
镜像分组
获取镜像分组列表
添加镜像分组
获取镜像分组详情
编辑镜像分组
删除镜像分组
获取服务器分组列表
规格管理
添加规格
获取规格列表
获取规格信息
修改规格
删除规格
获取规格详情
规格分配服务器
获取规格中可用的服务器
获取规格列表
规格服务器列表
通知模板管理
通知模板列表
添加通知模板
通知模板修改
通知模板删除
获取语言列表
获取通知类型
获取供应商列表
获取 供应商字段
获取供应商配置字段
添加或编辑供应商配置字段
驱动管理
获取驱动列表
添加驱动
获取驱动详情
编辑驱动
删除驱动
获取驱动下拉列表
SSH Keys
获取 SSH Key 列表
添加 SSH Key
修改 SSH Key
删除 SSH Key
首页
首页统计
返修
返修列表
任务
任务列表
取消任务
任务详情
全局搜索
全局搜索
交换机管理
交换机端口关联关系管理
获取所有交换机端口的关联关系
刷新所有交换机端口的关联关系
更新交换机拓扑图多点位置信息
删除交换机拓扑图单点位置信息
交换机脚本管理
获取交换机控制脚本内置变量
获取交换机控制脚本列表
创建交换机控制脚本
获取交换机控制脚本详情
修改交换机控制脚本
删除交换机控制脚本
交换机关联控制脚本
交换机管理
预览交换机控制脚本
执行交换机控制脚本
获取端口详情
获取交换机 Chassis Mac
Web 远程连接
创建交换机上下联
删除交换机上下联
获取交换机详情
修改交换机
删除交换机
获取交换机端口列表
获取交换机端口列表V2
获取端口差异列表
更新端口差异
修改交换机备注
抓取交换机SNMP连接状态
获取交换机自定义字段
创建交换机自定义字段
修改交换机自定义字段
删除交换机自定义字段
获取网关地址IP
获取交换机IP段
执行交换机端口开关脚本
执行交换机端口限速脚本
执行交换机端口vlan脚本
获取端口流量
修改端口备注
端口流量排行
更新端口mac
解锁交换机mac地址绑定
加锁交换机mac地址绑定
交换机端口状态获取
交换机端口名备注修改
交换机端口自动获取mac
交换机端口自动获取物理mac
交换机端口自动获取链路速率
交换机端口自动获取mtu
获取交换机端口上的所有mac地址
交换机高级功能
添加交换机ARP绑定
删除交换机ARP绑定
添加交换机ACL绑定
删除交换机ACL绑定
执行交换机批量动作
交换机故障申报
开启交换机Netconf功能
获取交换机关联网关
增加交换机网关关联
解除交换机网关关联
交换机流量与会话管理
获取指定交换机端口的流量
获取指定端口的流量
获取交换机信息
获取交换机在线的会话
修改交换机账号密码
获取交换机扩展支持
获取交换机列表
添加交换机
修改简单锁定
通过 SNMP 获取交换机型号
硬件管理
数据模型
ImagePartitionBrief
Server
SessionCredential
ImagePartitionDetail
ServerCreate
ImagePartitionCreate
ServerUpdate
ImagePartitionUpdate
IpBlock
VirtualDisk
Part
Partition
IpmiUser
ErrorResponse
4. 会话管理(REST)
复制页面
查询会话在线用户
GET
/servers/{id}/sessions
调试
Run in Apifox
Run in Apifox
列出该服务器当前控制台会话的在线连接(含通过共享链接进入的观看者),用于审计与管理。
请求参数
Authorization
API Key
在 header 添加参数
token
示例:
token: ********************
or
Path 参数
生成代码
请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例
请求示例
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
'/servers//sessions'
\
--header
'token: <api-key>'
返回响应
🟢
200
application/json
在线会话列表
Body
application/json
生成代码
示例
{
}
修改于
2026-08-07 08:35:26
上一页
关闭服务器控制台会话
下一页
控制台连接诊断