ProxmoxVE-AMS
  1. API
ProxmoxVE-AMS
  • 后台
    • API管理
      • 添加API key
      • 分页获取API信息
      • 删除指定ID的API key
      • 停用指定API
      • 启用指定API
    • IP池管理
      • 根据掩码位批量插入IP
      • 根据IP范围批量插入IP
      • 分页查询IP池列表
      • 查询指定IP池下的IP列表
      • 更新IP池信息
      • 修改IP信息
      • 删除指定IP池
    • OS管理
      • 获取在线系统列表
      • 激活在线OS
      • 手动新增OS
      • 分页获取已添加OS
      • 分页带条件获取已添加os
      • 下载镜像
      • 删除os
      • 修改os
    • 登录鉴权
      • 登陆接口
    • 地区管理
      • 增加地区
      • 删除地区
      • 修改地区
      • 分页查询地区
      • 查询指定id的地区
      • 添加某节点到指定地区
      • 获取指定地区的节点列表
      • 获取指定父级地区的子地区列表
      • 分页查询父级(一级)地区
    • 节点池管理
      • 网卡管理
        • 获取节点网卡信息
        • 获取节点网卡配置文件信息
        • 创建指定节点虚拟网卡
      • 负载信息
        • 查询单个节点状态
        • 获取指定节点负载信息
        • 获取节点总数
      • SDN
        • vnets
          • subnets
            • 添加子网
            • 根据vnet查询subnet列表
          • 添加vnet区域
          • 查询vnet列表
        • 添加sdn区域
        • 根据id删除sdn区域
        • 根据标识zone删除sdn区域
        • 查询sdn区域列表
      • NAT相关
        • PVE主控创建NAT
      • 添加PVE主控节点
      • 分页获取集群节点列表
      • 修改集群节点信息
      • 删除指定ID节点
    • 超管账号管理
      • 添加超管账号
      • 分页查询超管账号
      • 修改超管账号接口
      • 根据uuid查询超管
      • 删除超管账号
    • 实例管理
      • 模板管理
      • 配置模板管理
        • 增加配置模板
        • 删除配置模板
        • 修改配置模板
        • 分页查询配置模板
      • 实例操作
        • NAT
          • 添加虚拟机NAT规则
          • 删除虚拟机NAT规则
          • 获取虚拟机NAT规则
          • 获取虚拟机NAT相关信息
        • 电源状态操作
        • 重装虚拟机系统
        • 删除虚拟机
      • 创建虚拟机
      • 分页获取实例信息
      • 带参数分页获取实例信息
      • 获取虚拟机主机信息
      • 获取虚拟机历史负载
      • 获取指定虚拟机的vnc地址
      • 以降序排列获取虚拟机分页列表
      • 分页获取指定状态的虚拟机列表
      • 获取指定状态的虚拟机总数
      • 获取实例总数
      • 修改指定虚拟机的VNC密码
    • 系统设置
      • 获取被控通讯密钥
      • 获取全局虚拟机默认系统盘大小
      • 修改全局虚拟机默认系统盘大小
      • 获取全部配置
      • 修改系统配置
    • 日志管理
    • 限制功能
      • CPU模型管理
        • 新增cpu信息模型
        • 删除cpu信息模型
        • 修改cpu信息模型
        • 查询cpu信息模型
        • 分页查询cpu信息模型
      • 硬件模型管理
        • 新增smbios信息模型
        • 删除smbios信息模型
        • 修改smbios信息模型
        • 查询smbios信息模型
        • 分页查询smbios信息模型
      • 组合模板
        • 添加模型组
        • 删除模型组
        • 修改模型组
        • 查询模型组
        • 分页查询模型组
    • VNC控制器管理
      • 增加vnc控制器节点
      • 删除vnc控制器节点
      • 修改vnc控制器节点
      • 分页查询vnc控制器节点
  • API
    • NAT
      • 添加虚拟机NAT规则
      • 删除虚拟机NAT规则
      • 获取虚拟机NAT规则
      • 获取虚拟机NAT相关信息
    • 创建虚拟机
      POST
    • 虚拟机电源状态管理
      PUT
    • 重装系统
      PUT
    • 删除虚拟机
      DELETE
    • 修改虚拟机密码
      PUT
    • 续期
      PUT
    • 获取指定虚拟机数据
      GET
    • 获取指定虚拟机的vnc地址
      GET
    • 修改指定虚拟机的VNC密码
      PUT
    • 通讯测试
      GET
    • 分页获取实例信息
      GET
    • 带参数分页获取实例信息
      GET
    • 以降序排列获取虚拟机分页列表
      GET
    • 获取实例总数
      GET
    • 获取虚拟机历史负载
      GET
    • 分页获取指定状态的虚拟机列表
      GET
    • 获取指定状态的虚拟机总数
      GET
  • 通用接口
    • 获取CPU类型
    • 获取OS类型
    • 获取OS架构列表
    • 获取系统版本信息
  • 受控端
    • 状态查询
    • 获取版本号
    • 获取指定目录文件列表
    • 下载文件到指定目录
    • 重置虚拟机密码
    • 删除指定目录下的指定文件
    • 更新程序
    • 导入磁盘到虚拟机
    • 读取指定目录下文件的内容
    • 创建VNC服务
    • 停止指定vnc服务
    • 导入vnc配置信息
    • 重启网桥
    • 添加端口转发规则
    • 删除端口转发规则
    • 获取端口转发规则
    • 添加端口转发接口
  1. API

获取指定虚拟机数据

测试中
GET
/api/v1/{nodeType}/getVmInfo
最后修改时间:2024-12-30 09:46:23
责任人:mryunqi
current字段为当前运行实时监控数据,rrddata为历史数据,历史数据默认为一天

请求参数

Authorization
在 header 添加参数
Authorization
示例:
Authorization: ********************
Path 参数
nodeType
string 
必需
虚拟化平台,目前只有pve
示例值:
pve
Query 参数
hostId
integer 
可选
虚拟机ID(可以vmid或者键ID)

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/pve/getVmInfo?hostId=' \
--header 'Authorization;'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
data
object 
必需
info
object 
必需
status
object 
必需
示例
{
    "code": 20000,
    "message": "请求成功",
    "data": {
        "nodeName": null,
        "area": "中国",
        "vmhost": {
            "id": 13,
            "nodeid": 1,
            "vmid": 101,
            "name": "qimen",
            "configureTemplateId": null,
            "sockets": 2,
            "cores": 2,
            "threads": 2,
            "devirtualization": false,
            "kvm": true,
            "cpuModel": null,
            "modelGroup": null,
            "cpu": "kvm64",
            "cpuUnits": 1024,
            "bwlimit": 512000,
            "args": null,
            "arch": "x86_64",
            "acpi": 1,
            "memory": 1024,
            "swap": null,
            "agent": 1,
            "username": "root",
            "password": "123456",
            "ide0": null,
            "ide2": "local-lvm:cloudinit",
            "net0": "virtio,bridge=vmbr0",
            "net1": null,
            "os": "CentOS-8-Stream-x64.qcow2",
            "osName": "CentOS-8-Stream-x64",
            "osType": "linux",
            "iso": null,
            "template": null,
            "onBoot": 0,
            "bandwidth": 1000,
            "storage": "local-lvm",
            "systemDiskSize": 40,
            "dataDisk": null,
            "bridge": "vmbr0",
            "ipConfig": {
                "1": "ip=192.168.36.3/24,gw=192.168.36.2"
            },
            "ipData": [
                {
                    "ip": "192.168.36.3",
                    "subnetMask": 24,
                    "gateway": "192.168.36.2"
                }
            ],
            "nested": 0,
            "task": {
                "1700308921645": 203,
                "1700308936706": 204,
                "1700308938728": 205,
                "1700308940746": 206
            },
            "status": 0,
            "createTime": 1700308921584,
            "expirationTime": 2015668921584,
            "ipList": [
                "192.168.36.3"
            ]
        },
        "os": {
            "id": 3,
            "name": "CentOS-8-Stream-x64",
            "fileName": "CentOS-8-Stream-x64.qcow2",
            "type": "linux",
            "arch": "x86_64",
            "osType": "centos",
            "nodeStatus": {
                "0": {
                    "nodeId": 1,
                    "status": 2,
                    "nodeName": "pve",
                    "schedule": 100
                }
            },
            "downType": 0,
            "url": "https://mirror.chuqiyun.com/cloud-images/centos/CentOS-8-Stream-x64.qcow2",
            "size": "671MB",
            "path": "/home/images/",
            "cloud": 1,
            "status": 0,
            "reason": null,
            "createTime": 1698662508139
        },
        "current": {
            "data": {
                "nics": {
                    "tap101i0": {
                        "netin": 35462,
                        "netout": 12169
                    }
                },
                "freemem": 77418496,
                "running-qemu": "7.2.0",
                "maxmem": 1073741824,
                "diskread": 563062450,
                "status": "running",
                "cpus": 4,
                "ballooninfo": {
                    "last_update": 1700894642,
                    "mem_swapped_out": 48791552,
                    "minor_page_faults": 705922,
                    "total_mem": 807354368,
                    "major_page_faults": 1902,
                    "mem_swapped_in": 3076096,
                    "free_mem": 77418496,
                    "max_mem": 1073741824,
                    "actual": 1073741824
                },
                "blockstat": {
                    "ide2": {
                        "wr_highest_offset": 0,
                        "unmap_operations": 0,
                        "wr_merged": 0,
                        "failed_rd_operations": 0,
                        "wr_operations": 0,
                        "rd_bytes": 278706,
                        "idle_time_ns": 384402393488,
                        "timed_stats": [],
                        "flush_total_time_ns": 0,
                        "invalid_rd_operations": 0,
                        "rd_total_time_ns": 41182463,
                        "failed_wr_operations": 0,
                        "failed_flush_operations": 0,
                        "account_failed": true,
                        "invalid_wr_operations": 0,
                        "invalid_flush_operations": 0,
                        "unmap_total_time_ns": 0,
                        "wr_total_time_ns": 0,
                        "invalid_unmap_operations": 0,
                        "unmap_merged": 0,
                        "unmap_bytes": 0,
                        "account_invalid": true,
                        "flush_operations": 0,
                        "failed_unmap_operations": 0,
                        "rd_merged": 0,
                        "wr_bytes": 0,
                        "rd_operations": 80
                    },
                    "scsi0": {
                        "account_invalid": true,
                        "flush_operations": 154,
                        "unmap_bytes": 0,
                        "wr_bytes": 76163584,
                        "rd_operations": 14379,
                        "failed_unmap_operations": 0,
                        "rd_merged": 0,
                        "unmap_total_time_ns": 0,
                        "invalid_wr_operations": 0,
                        "invalid_flush_operations": 0,
                        "unmap_merged": 0,
                        "wr_total_time_ns": 5255532132,
                        "invalid_unmap_operations": 0,
                        "flush_total_time_ns": 46447197,
                        "idle_time_ns": 11116062098,
                        "timed_stats": [],
                        "failed_flush_operations": 0,
                        "failed_wr_operations": 0,
                        "account_failed": true,
                        "invalid_rd_operations": 0,
                        "rd_total_time_ns": 12363240977,
                        "wr_highest_offset": 42006446080,
                        "unmap_operations": 0,
                        "wr_operations": 1470,
                        "rd_bytes": 562783744,
                        "wr_merged": 0,
                        "failed_rd_operations": 0
                    }
                },
                "ha": {
                    "managed": 0
                },
                "cpu": 0.0219741222906965,
                "name": "qimen",
                "running-machine": "pc-i440fx-7.2+pve0",
                "diskwrite": 76163584,
                "serial": 1,
                "netin": 35462,
                "pid": 7768,
                "uptime": 415,
                "vmid": 101,
                "agent": 1,
                "netout": 12169,
                "proxmox-support": {
                    "pbs-dirty-bitmap-migration": true,
                    "pbs-masterkey": true,
                    "query-bitmap-info": true,
                    "backup-max-workers": true,
                    "pbs-dirty-bitmap-savevm": true,
                    "pbs-library-version": "1.3.1 (4d450bb294cac5316d2f23bf087c4b02c0543d79)",
                    "pbs-dirty-bitmap": true
                },
                "maxdisk": 42949672960,
                "qmpstatus": "running",
                "disk": 0,
                "balloon": 1073741824,
                "mem": 729935872
            }
        },
        "rrddata": {
            "data": [
                {
                    "time": 1700890500
                },
                {
                    "time": 1700890560
                },
                {
                    "time": 1700890620
                },
                {
                    "time": 1700890680
                },
                {
                    "time": 1700890740
                },
                {
                    "time": 1700890800
                },
                {
                    "time": 1700890860
                },
                {
                    "time": 1700890920
                },
                {
                    "time": 1700890980
                },
                {
                    "time": 1700891040
                },
                {
                    "time": 1700891100
                },
                {
                    "time": 1700891160
                },
                {
                    "time": 1700891220
                },
                {
                    "time": 1700891280
                },
                {
                    "time": 1700891340
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700891400,
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700891460,
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4
                },
                {
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824,
                    "time": 1700891520,
                    "maxdisk": 42949672960
                },
                {
                    "time": 1700891580,
                    "maxdisk": 42949672960,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700891640
                },
                {
                    "time": 1700891700,
                    "maxdisk": 42949672960,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700891760
                },
                {
                    "time": 1700891820,
                    "maxdisk": 42949672960,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700891880,
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxdisk": 42949672960,
                    "time": 1700891940
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700892000,
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxdisk": 42949672960,
                    "time": 1700892060
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700892120
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700892180,
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700892240,
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700892300
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700892360,
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700892420
                },
                {
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxdisk": 42949672960,
                    "time": 1700892480
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700892540,
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700892600
                },
                {
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824,
                    "time": 1700892660,
                    "maxdisk": 42949672960
                },
                {
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824,
                    "time": 1700892720,
                    "maxdisk": 42949672960
                },
                {
                    "time": 1700892780,
                    "maxdisk": 42949672960,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824
                },
                {
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824,
                    "time": 1700892840,
                    "maxdisk": 42949672960
                },
                {
                    "time": 1700892900,
                    "maxdisk": 42949672960,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824
                },
                {
                    "time": 1700892960,
                    "maxdisk": 42949672960,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700893020,
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700893080
                },
                {
                    "time": 1700893140,
                    "maxdisk": 42949672960,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824
                },
                {
                    "time": 1700893200,
                    "maxdisk": 42949672960,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824
                },
                {
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824,
                    "time": 1700893260,
                    "maxdisk": 42949672960
                },
                {
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824,
                    "time": 1700893320,
                    "maxdisk": 42949672960
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700893380,
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700893440,
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700893500
                },
                {
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824,
                    "time": 1700893560,
                    "maxdisk": 42949672960
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700893620,
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4
                },
                {
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824,
                    "time": 1700893680,
                    "maxdisk": 42949672960
                },
                {
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824,
                    "time": 1700893740,
                    "maxdisk": 42949672960
                },
                {
                    "time": 1700893800,
                    "maxdisk": 42949672960,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824
                },
                {
                    "maxcpu": 4,
                    "disk": 0,
                    "maxmem": 1073741824,
                    "time": 1700893860,
                    "maxdisk": 42949672960
                },
                {
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxdisk": 42949672960,
                    "time": 1700893920
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700893980,
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "maxmem": 1073741824,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "time": 1700894040
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700894100,
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "disk": 0,
                    "maxcpu": 4,
                    "maxmem": 1073741824,
                    "time": 1700894160,
                    "maxdisk": 42949672960
                },
                {
                    "maxdisk": 42949672960,
                    "time": 1700894220,
                    "maxmem": 1073741824,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "disk": 0,
                    "maxcpu": 4,
                    "mem": 387054295.322034,
                    "cpu": 0.387478816192326,
                    "netout": 159.785714285714,
                    "maxdisk": 42949672960,
                    "maxmem": 1073741824,
                    "time": 1700894280,
                    "diskwrite": 1430548.89795918,
                    "netin": 450.773469387755,
                    "diskread": 11307531.9918367
                },
                {
                    "netout": 12.0716666666667,
                    "cpu": 0.0238379856951775,
                    "maxdisk": 42949672960,
                    "maxcpu": 4,
                    "disk": 0,
                    "mem": 725369924.266667,
                    "diskread": 97443.84,
                    "time": 1700894340,
                    "diskwrite": 52933.9733333333,
                    "netin": 35.285,
                    "maxmem": 1073741824
                },
                {
                    "mem": 728859989.333333,
                    "disk": 0,
                    "maxcpu": 4,
                    "maxdisk": 42949672960,
                    "cpu": 0.022700290662013,
                    "netout": 5.88666666666667,
                    "diskread": 5529.6,
                    "maxmem": 1073741824,
                    "netin": 19.15,
                    "diskwrite": 5126.82666666667,
                    "time": 1700894400
                },
                {
                    "netin": 17.4166666666667,
                    "time": 1700894460,
                    "diskwrite": 2501.97333333333,
                    "maxmem": 1073741824,
                    "diskread": 18773.3333333333,
                    "maxdisk": 42949672960,
                    "cpu": 0.023346304181318,
                    "netout": 2.65,
                    "mem": 739424802.133333,
                    "maxcpu": 4,
                    "disk": 0
                },
                {
                    "diskread": 0,
                    "maxmem": 1073741824,
                    "netin": 21.4,
                    "time": 1700894520,
                    "diskwrite": 2182.82666666667,
                    "mem": 741955857.066667,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxdisk": 42949672960,
                    "netout": 7.86666666666667,
                    "cpu": 0.0237573758742922
                },
                {
                    "maxdisk": 42949672960,
                    "netout": 34.735,
                    "cpu": 0.0222518400776516,
                    "mem": 741650295.466667,
                    "maxcpu": 4,
                    "disk": 0,
                    "diskread": 136.533333333333,
                    "netin": 94.8716666666667,
                    "time": 1700894580,
                    "diskwrite": 947.2,
                    "maxmem": 1073741824
                },
                {
                    "mem": 736406186.666667,
                    "maxcpu": 4,
                    "disk": 0,
                    "maxdisk": 42949672960,
                    "netout": 9.115,
                    "cpu": 0.022881902347377,
                    "maxmem": 1073741824,
                    "netin": 34.145,
                    "time": 1700894640,
                    "diskwrite": 37411.84,
                    "diskread": 819.2
                }
            ]
        }
    }
}
上一页
续期
下一页
获取指定虚拟机的vnc地址
Built with