ProxmoxVE-AMS
  1. 实例管理
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相关信息
        • 电源状态操作
        • 重装虚拟机系统
        • 删除虚拟机
      • 创建虚拟机
        POST
      • 分页获取实例信息
        GET
      • 带参数分页获取实例信息
        GET
      • 获取虚拟机主机信息
        GET
      • 获取虚拟机历史负载
        GET
      • 获取指定虚拟机的vnc地址
        GET
      • 以降序排列获取虚拟机分页列表
        GET
      • 分页获取指定状态的虚拟机列表
        GET
      • 获取指定状态的虚拟机总数
        GET
      • 获取实例总数
        GET
      • 修改指定虚拟机的VNC密码
        PUT
    • 系统设置
      • 获取被控通讯密钥
      • 获取全局虚拟机默认系统盘大小
      • 修改全局虚拟机默认系统盘大小
      • 获取全部配置
      • 修改系统配置
    • 日志管理
    • 限制功能
      • 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. 实例管理

分页获取实例信息

GET
/{adminPath}/getVmByPage
最后修改时间:2023-08-31 13:01:24
责任人:未设置

请求参数

Path 参数
adminPath
string 
必需
示例值:
admin
Query 参数
page
integer 
可选
示例值:
1
size
integer 
可选
示例值:
20
Header 参数
Authorization
string 
可选
示例值:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1dWlkIjoiMjQzZTNlZTItZjk5Zi00OTk1LTg2YWQtMjViNzIyZjIyNGNhMSIsInNlY3JldCI6Ijc2M3dBcE41dnVpUnYwTmtReWFQSDZaMTVETkRvRjdYaFRlcFhCYnNFWkE9IiwiZXhwIjoxNjkzNDkyNDEyfQ.7weJmkU9Y8zbmgSPA0IktHreqF-5YdQ0SEidC38utdg

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/admin/getVmByPage?page=1&size=20' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1dWlkIjoiMjQzZTNlZTItZjk5Zi00OTk1LTg2YWQtMjViNzIyZjIyNGNhMSIsInNlY3JldCI6Ijc2M3dBcE41dnVpUnYwTmtReWFQSDZaMTVETkRvRjdYaFRlcFhCYnNFWkE9IiwiZXhwIjoxNjkzNDkyNDEyfQ.7weJmkU9Y8zbmgSPA0IktHreqF-5YdQ0SEidC38utdg'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
data
object 
必需
total
integer 
必需
current
integer 
必需
pages
integer 
必需
size
integer 
必需
records
array [object {3}] 
必需
示例
{
    "code": 20000,
    "message": "请求成功",
    "data": {
        "total": 1,
        "current": 1,
        "pages": 1,
        "size": 20,
        "records": [
            {
                "vmhost": {
                    "id": 25,
                    "nodeid": 1,
                    "vmid": 103,
                    "name": "VM-01",
                    "sockets": 1,
                    "cores": 2,
                    "threads": 2,
                    "devirtualization": false,
                    "kvm": true,
                    "cpuModel": null,
                    "modelGroup": null,
                    "cpu": "host",
                    "cpuUnits": 1024,
                    "args": null,
                    "arch": "x86_64",
                    "acpi": 1,
                    "memory": 1024,
                    "swap": null,
                    "agent": 1,
                    "ide0": null,
                    "ide2": "local-lvm:cloudinit",
                    "net0": "virtio,bridge=vmbr0",
                    "net1": null,
                    "os": "CentOS-8-Stream-x64.qcow2",
                    "osType": "linux",
                    "iso": null,
                    "template": null,
                    "onBoot": 1,
                    "bandwidth": 100,
                    "storage": "local-lvm",
                    "systemDiskSize": 40,
                    "dataDisk": {
                        "1": 40
                    },
                    "bridge": "vmbr0",
                    "ipConfig": {
                        "1": "ip=192.168.36.1/24,gw=192.168.36.2"
                    },
                    "nested": 0,
                    "task": {
                        "1692783654292": 135,
                        "1692783654310": 136,
                        "1692783693695": 137,
                        "1692783694983": 138,
                        "1692783695855": 139,
                        "1692783696541": 140
                    },
                    "status": 0,
                    "createTime": 1692783654293,
                    "expirationTime": 2008143654293
                },
                "current": {
                    "data": {
                        "running-qemu": "6.1.0",
                        "name": "VM-01",
                        "mem": 553115648,
                        "disk": 0,
                        "pid": 41319,
                        "status": "running",
                        "diskread": 857323698,
                        "proxmox-support": {
                            "pbs-dirty-bitmap-savevm": true,
                            "pbs-masterkey": true,
                            "query-bitmap-info": true,
                            "pbs-dirty-bitmap": true,
                            "pbs-dirty-bitmap-migration": true,
                            "pbs-library-version": "1.2.0 (6e555bc73a7dcfb4d0b47355b958afd101ad27b5)"
                        },
                        "agent": 1,
                        "nics": {
                            "tap103i0": {
                                "netout": 2048408,
                                "netin": 146164136
                            }
                        },
                        "cpu": 0.0312977631257886,
                        "maxdisk": 42949672960,
                        "freemem": 254599168,
                        "qmpstatus": "running",
                        "diskwrite": 552444416,
                        "blockstat": {
                            "scsi1": {
                                "account_invalid": true,
                                "wr_operations": 0,
                                "rd_merged": 0,
                                "unmap_total_time_ns": 0,
                                "unmap_bytes": 0,
                                "unmap_merged": 0,
                                "rd_total_time_ns": 119191813,
                                "wr_bytes": 0,
                                "timed_stats": [],
                                "failed_unmap_operations": 0,
                                "failed_flush_operations": 0,
                                "idle_time_ns": 66957079181668,
                                "invalid_wr_operations": 0,
                                "unmap_operations": 0,
                                "invalid_unmap_operations": 0,
                                "flush_total_time_ns": 0,
                                "failed_rd_operations": 0,
                                "wr_highest_offset": 0,
                                "rd_operations": 434,
                                "account_failed": true,
                                "wr_merged": 0,
                                "invalid_flush_operations": 0,
                                "failed_wr_operations": 0,
                                "flush_operations": 0,
                                "invalid_rd_operations": 0,
                                "wr_total_time_ns": 0,
                                "rd_bytes": 9629696
                            },
                            "ide2": {
                                "unmap_bytes": 0,
                                "unmap_total_time_ns": 0,
                                "rd_merged": 0,
                                "account_invalid": true,
                                "wr_operations": 0,
                                "unmap_operations": 0,
                                "invalid_wr_operations": 0,
                                "failed_flush_operations": 0,
                                "failed_unmap_operations": 0,
                                "idle_time_ns": 66956996453557,
                                "timed_stats": [],
                                "wr_bytes": 0,
                                "rd_total_time_ns": 31770289,
                                "unmap_merged": 0,
                                "invalid_flush_operations": 0,
                                "wr_merged": 0,
                                "account_failed": true,
                                "rd_operations": 80,
                                "wr_highest_offset": 0,
                                "failed_rd_operations": 0,
                                "flush_total_time_ns": 0,
                                "invalid_unmap_operations": 0,
                                "wr_total_time_ns": 0,
                                "rd_bytes": 278706,
                                "invalid_rd_operations": 0,
                                "flush_operations": 0,
                                "failed_wr_operations": 0
                            },
                            "scsi0": {
                                "unmap_merged": 0,
                                "rd_total_time_ns": 23389570377,
                                "wr_bytes": 552444416,
                                "failed_unmap_operations": 0,
                                "failed_flush_operations": 0,
                                "idle_time_ns": 18807941480,
                                "timed_stats": [],
                                "unmap_operations": 0,
                                "invalid_wr_operations": 0,
                                "account_invalid": true,
                                "wr_operations": 13321,
                                "rd_merged": 0,
                                "unmap_total_time_ns": 0,
                                "unmap_bytes": 0,
                                "failed_wr_operations": 0,
                                "flush_operations": 4640,
                                "invalid_rd_operations": 0,
                                "wr_total_time_ns": 28158216376,
                                "rd_bytes": 847415296,
                                "flush_total_time_ns": 2741837421,
                                "invalid_unmap_operations": 0,
                                "wr_highest_offset": 42018529280,
                                "failed_rd_operations": 0,
                                "rd_operations": 23603,
                                "invalid_flush_operations": 0,
                                "wr_merged": 0,
                                "account_failed": true
                            }
                        },
                        "ballooninfo": {
                            "total_mem": 807714816,
                            "free_mem": 254599168,
                            "last_update": 1693025679,
                            "major_page_faults": 6841,
                            "minor_page_faults": 14395839,
                            "actual": 1073741824,
                            "max_mem": 1073741824,
                            "mem_swapped_out": 168591360,
                            "mem_swapped_in": 44277760
                        },
                        "uptime": 66977,
                        "vmid": 103,
                        "netin": 146164136,
                        "cpus": 2,
                        "maxmem": 1073741824,
                        "netout": 2048408,
                        "ha": {
                            "managed": 0
                        },
                        "balloon": 1073741824,
                        "running-machine": "pc-i440fx-6.1+pve0"
                    }
                },
                "rrddata": null
            }
        ]
    }
}
上一页
创建虚拟机
下一页
带参数分页获取实例信息
Built with