接口功能介绍
支持批量创建按量付费或包年包月云主机
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
计费模式:确认开通云主机的计费模式,详细查看计费模式
地域选择:选择创建云主机的资源池,详细查看地域和可用区
产品选型:购买弹性云主机前,请先阅读规格说明了解弹性云主机的选型基本信息,并通过查询一个或多个云主机规格资源接口,获取当前资源池可用云主机规格信息
网络规划:规划云主机的网络环境,详细查看弹性云主机-网络
注意事项:
成本估算:了解云主机的计费项
用户配额:确认个人在不同资源池下资源配额,可以通过用户配额查询接口进行查询
异步接口:该接口为异步接口,下单过后会拿到主订单ID(masterOrderID),后续可以调用根据masterOrderID查询云主机ID,使用主订单ID来对订单情况与开通成功后的资源ID进行查询
多台创建:当前接口只能创建多个同类型云主机,个性化创建不同类型云主机请使用接口创建一台按量付费或包年包月的云主机进行创建
企业项目:保证资源隔离,需确保所有资源与云主机处于相同企业项目下才可进行挂载操作,如网络资源:VPC、安全组、弹性IP、子网
标签绑定:云主机绑定标签时,标签键和值存在的情况下,绑定对应标签;不存在的情况下,创建新的标签并绑定云主机。主机创建完成后,云主机变为运行状态,此时标签仍可能未绑定,需等待一段时间(0-10分钟)
监控安装:在云服务器创建成功后,3-5分钟内将完成详细监控Agent安装,即开启云服务器CPU,内存,网络,磁盘,进程等指标详细监控,若不开启,则无任何监控数据。
代金券:只支持预付费用户抵扣包周期资源的金额,且不可超过包周期资源的金额
接口约束
1. 目前不支持预付费账户创建按需付费类型云主机
2. 计费模式选择包年包月计费方式时,需要填写订购周期类型与订购时长
3. 自动分配弹性IP(extIP="1")时,需要填写弹性IP版本(ipVersion)与带宽大小(bandwidth);使用已有的弹性IP(extIP="2")时,需要填写弹性IP的版本(ipVersion),和对应弹性IP的ID(eipID或ipv6AddressID)
4. 挂载网卡时,子网与虚拟私有云存在对应关系,确保子网属于当前虚拟私有云
5. 云主机绑定多个标签时,标签键(参数labelKey)不可重复,单台云主机最多可绑定10个标签
URI
POST /v4/ecs/batch-create-instances
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,其他请求参数相同时,则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
azName | 是 | String | 可用区名称,您可以查看地域和可用区来了解可用区 获取: 查 资源池可用区查询 注:查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default) |
cn-huadong1-jsnj1A-public-ctcloud | |
instanceName | 是 | String | 云主机名称,支持模式串(支持{R:数字}形式,且只支持使用1次,此处数字需为小于等于9799的正整数,不支持冒号“:”以及大括号“{}”两类字符单独存在或其它组合方式)。不同操作系统下,云主机名称规则有差异。 Windows:长度为2-15个字符(当创建两台及两台以上的云主机时名称长度为2-10个字符),允许使用大小写字母、数字或连字符(-)。不能以连字符(-)开头或结尾,不能连续使用连字符(-),也不能仅使用数字; 其他操作系统:长度为2-64字符(当创建两台及两台以上的云主机时名称长度为2-59个字符),允许使用点(.)分隔字符成多段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾,也不能仅使用数字 |
ecm-3300 | |
displayName | 是 | String | 云主机显示名称,支持模式串(支持{R:数字}形式,且只支持使用1次,此处数字需为小于等于9799的正整数,不支持冒号“:”以及大括号”{}”两类字符单独存在或其它组合方式),长度为2-63字符 | ecm-3300 | |
flavorID | 是 | String | 云主机规格ID,您可以查看规格说明了解弹性云主机的选型基本信息 获取: 查 查询一个或多个云主机规格资源 注:同一规格名称在不同资源池不同可用区的规格ID是不同的,调用前需确认规格ID是否归属当前资源池,多可用区资源池确认是否归属当前可用区 |
0824679a-dc86-47dc-a0d3-9c330928f4f6 | |
imageType | 是 | Integer | 镜像类型,取值范围: 0(私有镜像), 1(公有镜像), 2(共享镜像), 3(安全镜像), 4(甄选镜像) 您可以查看镜像概述查看关于云主机镜像介绍 |
1 | |
imageID | 是 | String | 镜像ID,您可以查看镜像概述来了解云主机镜像 获取: 查 查询可以使用的镜像资源 创 创建私有镜像(云主机系统盘) 创 创建私有镜像(云主机数据盘) 注:同一镜像名称在不同资源池的镜像ID是不同的,调用前需确认镜像ID是否归属当前资源池 |
9d9e8998-8ed5-43b2-99cb-322f2b8cf6fa | |
bootDiskType | 是 | String | 系统盘类型,取值范围: SATA(普通IO), SAS(高IO), SSD(超高IO), SSD-genric(通用型SSD), FAST-SSD(极速型SSD),您可以查看磁盘类型及性能介绍来了解磁盘类型及其对应性能指标 |
SATA | |
bootDiskSize | 是 | Integer | 系统盘大小单位为GiB,取值范围:[40, 32768],注:创建云主机过程中会存在单位转换,因此该参数只能传入整型,如果填写小数值则会被取整,影响到涉及计费 | 40 | |
vpcID | 是 | String | 虚拟私有云ID,您可以查看产品定义-虚拟私有云来了解虚拟私有云 获取: 查 查询VPC列表 创 创建VPC 注:在多可用区类型资源池下,vpcID通常为“vpc-”开头,非多可用区类型资源池vpcID为uuid格式 |
4797e8a1-722d-4996-9362-458001813e41 | |
onDemand | 是 | Boolean | 购买方式,取值范围: false(按周期), true(按需) 您可以查看计费模式了解云主机的计费模式 注:按周期(false)创建云主机需要同时指定cycleCount和cycleType参数 |
false | |
networkCardList | 是 | Array of Objects | 网卡信息列表,您可以查看弹性网卡概述了解弹性网卡相关信息 | networkCardList | |
extIP | 是 | String | 是否使用弹性公网IP,取值范围: 0(不使用), 1(自动分配), 2(使用已有)。 注:自动分配弹性公网,默认分配IPv4弹性公网,需填写带宽大小,如需ipv6请填写弹性IP版本(即参数extIP="1"时,需填写参数bandwidth、ipVersion,ipVersion含默认值ipv4); 使用已有弹性公网,请填写弹性公网IP的ID,默认为ipv4版本,如使用已有ipv6,请填写弹性ip版本(即参数extIP="2"时,需填写eipID或ipv6AddressID,同时ipv6情况下请填写ipVersion) |
2 | |
projectID | 否 | String | 企业项目ID,企业项目管理服务提供统一的云资源按企业项目管理,以及企业项目内的资源管理,成员管理。您可以通过查看创建企业项目了解如何创建企业项目 注:默认值为"0" |
6732237e53bc4591b0e67d750030ebe3 | |
secGroupList | 否 | Array of Strings | 安全组ID列表,您可以查看安全组概述了解安全组相关信息 获取: 查 查询用户安全组列表 创 创建安全组 注:在多可用区类型资源池下,安全组ID通常以“sg-”开头,非多可用区类型资源池安全组ID为uuid格式;默认使用默认安全组,无默认安全组情况下请填写该参数 |
["202ca2d2-273a-5995-873b-03731212c8e4"] | |
dataDiskList | 否 | Array of Objects | 数据盘信息列表,注:同一云主机下最多可挂载8块数据盘 | dataDiskList | |
ipVersion | 否 | String | 弹性IP版本,取值范围: ipv4(v4地址), ipv6(v6地址), 不指定默认为ipv4。注:请先确认该资源池是否支持ipv6(多可用区类资源池暂不支持) |
ipv4 | |
bandwidth | 否 | Integer | 带宽大小,单位为Mbit/s,取值范围:[1, 2000] | 100 | |
ipv6AddressID | 否 | String | 弹性公网IPv6的ID,注:多可用区类资源池暂不支持;填写该参数时请填写ipVersion为ipv6 | eip-5sdasd2gfh | |
eipID | 否 | String | 弹性公网IP的ID,您可以查看产品定义-弹性IP来了解弹性公网IP 获取: 查 查询指定地域已创建的弹性 IP 创 创建弹性 IP |
eip-9jpeyl0frh | |
affinityGroupID | 否 | String | 云主机组ID,获取: 查 查询云主机组列表或者详情 创 创建云主机组 |
259b0c37-1044-41d8-989e | |
keyPairID | 否 | String | 密钥对ID,您可以查看密钥对来了解密钥对相关内容 获取: 查 查询一个或多个密钥对 创 创建一对SSH密钥对 |
c57d0626-8a82-407b-a910-b454907778c3 | |
userPassword | 否 | String | 用户密码,满足以下规则: 长度在8~30个字符; 必须包含大写字母、小写字母、数字以及特殊符号中的三项; 特殊符号可选:()`~!@#$%^&*_-+=|{}[]:;'<>,.?/且不能以斜线号 / 开头; 不能包含3个及以上连续字符; Linux镜像不能包含镜像用户名(root)、用户名的倒序(toor)、用户名大小写变化(如RoOt、rOot等); Windows镜像不能包含镜像用户名(Administrator)、用户名大小写变化(adminiSTrator等) |
1qaz@WSX | |
cycleCount | 否 | Integer | 订购时长,该参数需要与cycleType一同使用 注:最长订购周期为60个月(5年);cycleType与cycleCount一起填写;按量付费(即onDemand为true)时,无需填写该参数(填写无效) |
6 | |
cycleType | 否 | String | 订购周期类型,取值范围: MONTH:按月, YEAR:按年。注:cycleType与cycleCount一起填写;按量付费(即onDemand为true)时,无需填写该参数(填写无效) |
MONTH | |
autoRenewStatus | 否 | Integer | 是否自动续订,取值范围: 0(不续费), 1(自动续费), 注:按月购买,自动续订周期为1个月;按年购买,自动续订周期为1年 |
1 | |
userData | 否 | String | 用户自定义数据,需要以Base64方式编码,Base64编码后的长度限制为1-16384字符。 |
ZWNobyBoZWxsbyBnb3N0YWNrIQ== | |
orderCount | 否 | Integer | 购买数量,取值范围:[1, 50]。注:不填则默认为1 | 1 | |
payVoucherPrice | 否 | Float | 代金券,满足以下规则:两位小数,不足两位自动补0,超过两位小数无效;不可为负数;字段为0时表示不使用代金券 | 20.55 | |
labelList | 否 | Array of Objects | 标签信息列表,注:单台云主机最多可绑定10个标签;云主机创建完成后,云主机变为运行状态,此时标签仍可能未绑定,需等待一段时间(0~10分钟);批量创建云主机时并非云主机对应labelList中各个标签进行对应绑定,而是这一批的所有云主机都会绑定labelList中所有的标签。 | labelList | |
gpuDriverKits | 否 | String | GPU云主机安装驱动的工具包,仅在同时选择NVIDIA显卡、计算加速型、linux公共镜像三个条件下,支持安装驱动 | CUDA 11.4.3 Driver 470.82.01 CUDNN 8.8.1.3 | |
monitorService | 否 | Boolean | 监控参数,支持通过该参数指定云主机在创建后是否开启详细监控,取值范围: false(不开启), true(开启) 若指定该参数为true或不指定该参数,云主机内默认开启最新详细监控服务。 若指定该参数为false,默认公共镜像不开启最新监控服务;私有镜像使用镜像中保留的监控服务。 说明:仅部分资源池支持monitorService参数,详细请参考监控Agent概览。 |
true |
表 dataDiskList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskMode | 否 | String | 云硬盘属性,取值范围: FCSAN(光纤通道协议的SAN网络), ISCSI(小型计算机系统接口), VBD(虚拟块存储设备) 您可以查看磁盘模式及使用方法 注:默认为VBD |
VBD | |
diskType | 是 | String | 云硬盘类型,取值范围: SATA(普通IO), SAS(高IO), SSD(超高IO), SSD-genric(通用型SSD), FAST-SSD(极速型SSD) 您可以查看磁盘类型及性能介绍磁盘类型相关信息 |
SATA | |
diskSize | 是 | Integer | 磁盘容量,单位为GB,取值范围:[10, 32768] | 20 | |
cmkID | 否 | String | 加密密钥ID,注:加密数据盘填写该参数 | 9dcd1cf7-7969-4b3b-86a1-31f79682e219 | |
isEncrypt | 否 | Boolean | 磁盘是否加密,取值范围:true(加密)、false(不加密),注:默认值false;填写True时,需要填写加密密钥(cmkID),否则无效。 | false | |
diskName | 是 | String | 该参数暂时无法使用。云硬盘名称,长度限制2~63字符,不支持中文 | ebs.name |
表 networkCardList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
fixedIP | 否 | String | 内网IPv4地址, 注:不可使用已占用IP;当购买数量超过1时(orderCount>1),该参数不可使用 |
192.168.3.20 | |
isMaster | 是 | Boolean | 是否主网卡,取值范围: true(表示主网卡), false(表示扩展网卡) 注:只能含有一个主网卡 |
true | |
subnetID | 是 | String | 子网ID,您可以查看基本概念来查找子网的相关定义 获取: 查 查询子网列表 创 创建子网 注:在多可用区类型资源池下,subnetID通常以“subnet-”开头,非多可用区类型资源池subnetID为uuid格式 |
a90eebf0-d798-5017-b9f0-9468bb2301c2 | |
nicName | 否 | String | 该参数暂时无法使用。网卡名称,长度2~32,支持拉丁字母、中文、数字、下划线、连字符,中文或英文字母开头,不能以http:或https:开头 | net.name |
表 labelList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
labelKey | 是 | String | 标签键,长度限制1~32字符,注:同一台云主机绑定多个标签时,标签键不可重复 | test-key | |
labelValue | 是 | String | 标签值,长度限制1~32字符 | test-value |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态 查询订单状态及资源UUID: 查 根据masterOrderID查询云主机ID |
235145e4489811eda8330242ac110002 | |
masterOrderNO | String | 订单号 | 20221010142913884246 | |
masterResourceID | String | 主资源ID | 3cda4bf48cac42b8b7db3b279d2fc6fb | |
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1:多可用区类型资源池,创建按量付费的普通云主机(不使用密钥对、云主机组、弹性公网、自定义数据等内容,不挂数据盘、副网卡)
在华东1可用区1创建5台按需付费的云主机,系统盘为普通IO类型、大小40GB,规格为s7.small.1,镜像为共有镜像CentOS8.0 64位。
{
"clientToken": "please_create_your_own_clientToken_not_use_create_example_01",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"azName": "cn-huadong1-jsnj1A-public-ctcloud",
"instanceName": "create-test01",
"displayName": "api-create01",
"flavorID": "34e1b6f6-e974-1575-20b2-172ba0e0bf83",
"imageType": 1,
"imageID": "d39aba04-2470-4eea-acdc-10cb4f962588",
"bootDiskType": "SATA",
"bootDiskSize": 40,
"extIP": "0",
"onDemand": true,
"orderCount": 5,
"vpcID": "vpc-chz0ilszsp",
"networkCardList": [
{
"subnetID": "subnet-4c4333pc67",
"isMaster": true
}
]
}
示例2:非多可用区类型资源池,创建包年包月付费的普通云主机(不使用密钥对、云主机组、弹性公网、自定义数据等内容,不挂数据盘、副网卡)
在内蒙6创建1台包周期付费的云主机,购买六个月,系统盘为高IO类型、大小50GB,规格为s6.medium.2,镜像为共有镜像ubuntu16.04。
主网卡指定内网IP,使用已有弹性公网。
{
"clientToken": "please_create_your_own_clientToken_here_not_use_create_example_02",
"regionID": "6019b5007a0b11eab5db0242ac110002",
"azName": "default",
"instanceName": "create-test02",
"displayName": "api-create02",
"flavorID": "d7ac25ac-5dd9-4e8e-bb4e-3e9a861ad829",
"imageType": 1,
"imageID": "9f59941d-ae69-45e5-a6ee-1b6ec8da2bae",
"bootDiskType": "SATA",
"bootDiskSize": 50,
"extIP": "2",
"ipVersion": "ipv4",
"eipID": "8293c309-63aa-4e3a-8f9f-e7038f660c9c",
"onDemand": false,
"cycleType": "MONTH",
"cycleCount": 6,
"orderCount": 1,
"vpcID": "8d9698a5-f9e4-405b-a5a2-3468c25ddda1",
"networkCardList": [
{
"subnetID": "1932614b-e33a-466c-beb1-c399a86fa6b0",
"isMaster": true,
"fixedIP": "192.168.0.17"
}
]
}
示例3:多可用区类型资源池,创建按需付费的云主机,并绑定密钥对、加入云主机组,使用弹性公网、自定义数据,挂载数据盘与副网卡
在华东1可用区2创建4台按需付费的云主机,系统盘为高IO类型、大小100GB,规格为计算增强型c7.2xlarge.2,镜像为共有镜像Ubuntu 18.04 64位。
增加副网卡,增加一块20GB大小的数据盘,类型为普通IO;绑定密钥对,加入云主机组、自动分配公网IP,带宽为2,使用自定义数据,指定项目ID。
该次订购使用代金券支付,后续自动续订,绑定一组标签。
{
"clientToken": "please_create_your_own_clientToken_here_not_use_create_example_03",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"azName": "cn-huadong1-jsnj2A-public-ctcloud",
"instanceName": "create-test03",
"displayName": "api-create03",
"flavorID": "4c7da688-88fc-412d-d20e-f647dd4a8310",
"imageType": 1,
"imageID": "26ec204c-ebe5-47b9-bff9-32da77026228",
"bootDiskType": "SAS",
"bootDiskSize": 100,
"extIP": "1",
"ipVersion": "ipv4",
"bandwidth": 2,
"onDemand": true,
"orderCount": 3,
"vpcID": "vpc-chz0ilszsp",
"networkCardList": [
{
"subnetID": "subnet-4c4333pc67",
"isMaster": true
},
{
"subnetID": "subnet-3lrbkaj66a",
"isMaster": false
}
],
"dataDiskList": [
{
"diskMode": "VBD",
"diskType": "SATA",
"diskSize": 20
}
],
"keyPairID": "48edb5e9-c66a-3f74-907d-a45e771a8cef",
"affinityGroupID": "924b95c4-68d9-3fbe-835d-fee46397feda",
"projectID": "95e17b31e41e4d509687398baf91c260",
"autoRenewStatus": 1,
"userData": "b3BlbmFwaV91c2VyRGF0YV90ZXN0",
"payVoucherPrice": "450.00",
"labelList": [{
"labelKey": "test-label",
"labelValue": "test-value"
}]
}
响应示例
{
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "107e901c449611ed8b6a0242ac110002",
"masterResourceID": "34c7cc05a52b48eda0a84e34a82b346b",
"masterOrderNO": "20221009163836430197"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码