创建虚拟机 - ProxmoxVE-AMS

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Path 参数

nodeType

string

必需

虚拟化平台，目前只有pve

示例值:

pve

Body 参数application/json

nodeid

integer

节点ID

必需

hostname

string | null

虚拟机名

可选

configureTemplateId

integer | null

配置模板ID

可选

sockets

integer | null

插槽数，默认为1

可选

cores

integer | null

核心，默认1

可选

threads

integer | null

线程数，默认1

可选

devirtualization

boolean | null

可选

是否去虚拟化，默认false

kvm

boolean | null

可选

是否开启kvm虚拟化，默认开启

cpuModel

integer | null

cpu信息模型ID

可选

modelGroup

integer | null

可选

组合模型ID，优先级大于cpuModel

nested

boolean | null

可选

是否开启嵌套虚拟化，默认关闭

cpu

string | null

可选

cpu类型，默认kvm64，如果开启了nested，cpu必须为host或max

cpuUnits

integer | null

可选

cpu限制(单位:百分比)，列：10 为10%

bwlimit

integer | null

可选

I/O限制（单位MB/S），注意该参数为迁移服务器或克隆等操作才会有效，实际虚拟机I/O限制为下方的读写限制参数

flowLimit

integer | null

可选

月流量限制(单位:GB)

usedFlow

number | null

可选

月流量使用量(单位:GB)

arch

string | null

可选

系统架构(x86_64,arrch64)，默认x86_64

acpi

string | null

可选

acpi 默认1 开启

memory

integer | null

可选

内存单位Mb，默认512

storage

string | null

可选

PVE磁盘名，auto为自动

systemDiskSize

integer | null

可选

系统盘大小，单位Gb

mbpsRd

integer | null

可选

系统磁盘读取长效限制单位mb/s

mbpsRdMax

integer | null

可选

系统磁盘读取突发限制单位mb/s

mbpsWr

integer | null

可选

系统磁盘写入长效限制单位mb/s

mbpsWrMax

integer | null

可选

系统磁盘写入突发限制单位mb/s

iopsRd

integer | null

可选

系统磁盘iops读取长效限制单位ops/s

iopsRdMax

integer | null

可选

系统磁盘iops读取突发限制单位ops/s

iopsWr

integer | null

可选

系统磁盘iops写入长效限制单位ops/s

iopsWrMax

integer | null

可选

系统磁盘iops写入突发限制单位ops/s

dataDisk

可选

附加磁盘，最多添加25块，单位大小GB

bridge

string | null

网桥

可选

ipConfig

可选

os

string

必需

操作系统，可填镜像名称或id

osType

string | null

可选

操作系统类型，（windows|linux）

bandwidth

integer | null

带宽，单位Mbps

可选

onBoot

integer | null

可选

是否开机自启 0:否 1:是，默认0关闭

username

string | null

虚拟机登录用户名

可选

password

string | null

虚拟机登录密码

可选

expirationTime

integer | null

到期时间，时间戳

可选

ifnat

integer | null

是否开启nat

可选

natnum

integer | null

nat端口转发数量

可选

示例

{
    "nodeid": 1,
    "hostname": "cloud-test01",
    "sockets": 1,
    "cores": 2,
    "threads": 2,
    "nested": false,
    "modelGroup": 2,
    "cpu": "host",
    "arch": "x86_64",
    "memory": 512,
    "storage": "auto",
    "systemDiskSize": 40,
    "os": "CentOS-8-Stream-x64.qcow2",
    "osType": "linux",
    "bandwidth": 100,
    "ipConfig": {
        "1": ""
    },
    "dataDisk": {
        "1": 40
    },
    "onBoot": 1,
    "username": "root",
    "password": "123456",
    "ifnat": 1,
    "natnum": 10
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/pve/cerateVM' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "nodeid": 1,
    "hostname": "cloud-test01",
    "sockets": 1,
    "cores": 2,
    "threads": 2,
    "nested": false,
    "modelGroup": 2,
    "cpu": "host",
    "arch": "x86_64",
    "memory": 512,
    "storage": "auto",
    "systemDiskSize": 40,
    "os": "CentOS-8-Stream-x64.qcow2",
    "osType": "linux",
    "bandwidth": 100,
    "ipConfig": {
        "1": ""
    },
    "dataDisk": {
        "1": 40
    },
    "onBoot": 1,
    "username": "root",
    "password": "123456",
    "ifnat": 1,
    "natnum": 10
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

nodeid

integer

必需

hostid

integer

必需

vmid

integer

必需

hostname

string

必需

configureTemplateId

null

必需

sockets

integer

必需

cores

integer

必需

threads

integer

必需

nested

boolean

必需

devirtualization

boolean

必需

kvm

boolean

必需

cpuModel

null

必需

modelGroup

integer

必需

cpu

string

必需

cpuUnits

integer

必需

args

null

必需

arch

string

必需

acpi

integer

必需

memory

integer

必需

swap

null

必需

storage

string

必需

systemDiskSize

integer

必需

dataDisk

object

必需

bridge

string

必需

ipConfig

object

必需

dns1

string

必需

os

string

必需

osType

string

必需

iso

null

必需

template

null

必需

onBoot

integer

必需

bandwidth

integer

必需

username

string

必需

password

string

必需

task

null

必需

status

null

必需

expirationTime

null

必需

示例

{
    "code": 20000,
    "message": "请求成功",
    "data": {
        "nodeid": 1,
        "hostid": 34,
        "vmid": 102,
        "hostname": "cloud-test01",
        "configureTemplateId": null,
        "sockets": 1,
        "cores": 2,
        "threads": 2,
        "nested": false,
        "devirtualization": false,
        "kvm": true,
        "cpuModel": null,
        "modelGroup": 2,
        "cpu": "host",
        "cpuUnits": 1024,
        "args": null,
        "arch": "x86_64",
        "acpi": 1,
        "memory": 512,
        "swap": null,
        "storage": "local-lvm",
        "systemDiskSize": 40,
        "dataDisk": {
            "1": 40
        },
        "bridge": "vmbr0",
        "ipConfig": {
            "1": "ip=192.168.36.1/24,gw=192.168.36.2"
        },
        "dns1": "114.114.114.114",
        "os": "CentOS-8-Stream-x64.qcow2",
        "osType": "linux",
        "iso": null,
        "template": null,
        "onBoot": 1,
        "bandwidth": 100,
        "username": "root",
        "password": "123456",
        "task": null,
        "status": null,
        "expirationTime": null
    }
}