文档中心 API文档 实例创建

实例创建

更新时间:2022-07-26 14:19:10

适用产品

边缘云主机

接口描述

通过该接口您可以在某个区域申请指定规格的云主机实例,实例创建完毕之后,可通过使用实例查询接口获得实例的最新状态。 1)如果虚拟机需要使用内网网络并且未指定节点名称,则一次请求的虚拟机都将调度到同一个Cluster(只支持Cluster内的内网互通),非同一次请求的虚拟机无法保证虚拟机间内网互通,因为可能调度到不同的Cluster。不同节点、区域、省份或运营商的虚拟机间不支持内网互通,因为他们必定被调度到不同的Cluster。 2)如果创建请求携带了cidr的参数,则要求节点上或者没有虚拟机(可以是创建过但是都销毁了)或者已有虚拟机的cidr与当前请求一致,这样的节点才能创建虚拟机,如果找不到这样的节点,则虚拟机创建失败。如果不指定privateIPv4,cidr的第一个ip地址默认不会分配给虚拟机。例如,cidr=192.168.10.129/25,则虚拟机的ip分配范围从192.168.10.130开始,除非指定参数privateIPv4=192.168.10.129,才能创建ip为129的虚拟机。 3)如果请求参数中携带的是裸机模板,则表示创建裸机实例,此时不支持内网、不支持ipv6。

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Body 参数

参数名称类型必填描述
servers
List创建实例的数组对象
regionName
String实例所属区域(详见附录)
province
String实例所属省份(详见附录)
carrier
String实例所属运营商(详见附录)如果携带了该参数,请与'3.4节点列表查询'接口返回的carrier保持一致
nodeName
String节点名称,表示指定节点创建实例(接口3.4返回的节点名称)
imageId
String实例镜像标识
flavorId
String实例规格标识
name
String实例名称,如果创建数量大于1,则真实名称是在该参数后拼接3位数字。如instance_0001,instance_0002
userData
String注入用户数据,支持注入文本、文本文件或gzip文件。注入内容最大长度32KB。注入内容,需要进行base64格式编码。
count
Integer申请实例数量
password
String实例root用户登录密码
keyName
String实例登录SSH秘钥对名称,如果指定该参数,默认禁用密码登录方式,password参数同时失效
innerNet
String实例是否需要内网网络,取值: YES:需要内网 NO:不需要内网,默认值
cidr
String实例内网的cidr,只有innerNet=YES时才有意义
privateIPv4
String实例内网ip地址,如果指定了ip,必须在cidr的范围内,否则创建失败
protocols
Integer是否需要多ip协议地址 4:只需要ipv4地址,默认值 6:只需要ipv6地址 0:ipv4、ipv6都需要
isFree
String是否免费实例,默认计费实例,裸机实例不能免费,取值: YES:免费实例 NO:计费实例 如果使用免费实例,需要提前配置权限
securityGroupIds
List指定安全组id进行创建,多个安全组以逗号分隔,最多指定5个 如果是创建裸机,不能指定安全组
networkType
String网络类型: ANY-默认; DPDK-DPDK网络
diskInfo
List磁盘信息 如果携带该信息,将忽略模板上的磁盘定义,以该信息创建实例磁盘,不适用于裸机实例创建
size
Integer磁盘大小(GB)
type
String磁盘用途: SYSTEM-系统盘; DATA-数据盘
category
String磁盘类型:HDD/SSD
serverGroup
String反亲和性组名称 拥有相同serverGroup的虚拟机会被创建在不同的宿主机上
tag
String实例标签
useUniqueIpSegment
Integer是否使用唯一网段 1:是 -1:否

返回参数

Body 参数

参数名称类型描述
servers
List实例标识列表

示例

JSON
JSON
请求示例
复制代码 复制成功
POST /servers
{
"servers": [
{
        "regionName": "huanan",
        "province": "guangdong",
        "carrier": "dx",
        "imageId": "70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorId": "1",
        "name": "server-test",
        "securityGroupIds": ["11ceeeafa1d64c96b95d3a8c45bf7431","3b1da8aceeda42b4b3e23e723f88ffe9"],
        "networkType": "DPDK",
"diskInfo": [{
			"size": 40,
			"type": "SYSTEM",
			"category": "SSD"
		},
          {
			"size": 300,
			"type": "DATA",
			"category": "SSD"
		}]
},
{
        "regionName": "huanan",
        "province": "guangdong",
"carrier": "lt",
        "imageId": "70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorId": "2",
        "name": "server-test",
        "count": "2"
 }
]
}
返回示例
复制代码 复制成功
{
	"id": "[\"00239bab06374de6bccc62544e1a94d4\",\"002d08254f91496c8dc1da07419e565f\"]"
}
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!