接口功能介绍

支持创建一台按量付费或包年包月的云主机

接口约束

目前不支持预付费用户创建按量付费云主机
当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。

URI

POST /v4/ecs/create

路径参数
无

Query参数
无

请求参数

请求头header参数
无

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
clientToken	是	String	客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时	4cf2962d-e92c-4c00-9181-cfbb2218636c
regionID	是	String	资源池ID，您可以调用regionID查看最新的天翼云资源池列表	100054c0416811e9a6690242ac110002
azName	否	String	可用区名称。您可以调用获取资源池信息，查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空(即为单可用区，本字段填写default)。	az2
projectID	否	String	企业项目ID，默认值为0	6732237e53bc4591b0e67d750030ebe3
vmName	是	String	云主机名称。不同操作系统下，云主机名称规则有差异。 Windows：长度为2~15个字符，允许使用大小写字母、数字或连字符（-），不能以连字符（-）开头或结尾，不能连续使用连字符（-），也不能仅使用数字；其他操作系统：长度为2-64字符，允许使用点（.）分隔字符成多段，每段允许使用大小写字母、数字或连字符（-），但不能连续使用点号（.）或连字符（-），不能以点号（.）或连字符（-）开头或结尾，也不能仅使用数字。	ecm-3300
displayName	是	String	云主机显示名称，长度为2-63字符	ecm-3300
flavorID	是	String	云主机规格ID，您可以调用flavorID查看最新的天翼云具体资源池的云主机规格列	0824679a-dc86-47dc-a0d3-9c330928f4f6
imagePublic	是	Integer	镜像类型，取值范围: 0：私有镜像， 1：公有镜像， 2：共享镜像， 3：安全镜像， 4：甄选镜像	1
imageID	是	String	镜像ID，您可以调用imageID查看最新的天翼云具体资源池的镜像列表	9d9e8998-8ed5-43b2-99cb-322f2b8cf6fa
syshdType	是	String	系统盘类型，取值范围: SATA：普通IO SAS：高IO SSD：超高IO SSD-genric：通用型SSD FAST-SSD：极速型SSD	SATA
syshd	是	Integer	系统盘大小单位为GB，取值范围：[40-32768]	40
diskList	否	Array of Objects	数据盘		disks
vpc	是	String	虚拟私有云ID	4797e8a1-722d-4996-9362-458001813e41
onDemand	是	Boolean	购买方式，取值范围： false：按周期， true：按需，按周期创建云主机需要同时指定cycleCount和cycleType参数	false
secGroupList	否	Array of Strings	安全组ID列表，默认使用默认安全组，无默认安全组情况下请填写该参数	["202ca2d2-273a-5995-873b-03731212c8e4"]
networkCardList	是	Array of Objects	网卡		networkCardList
extIP	是	String	是否使用弹性公网IP，取值范围: 0：不使用， 1：自动分配，自动分配需指定带宽大小， 2：使用已有	2
ipType	否	String	弹性IP版本，取值范围: ipv4：v4地址 ipv6：v6地址，默认选择ipv4	ipv4
bandWidth	否	Integer	带宽大小单位为Mbit/s ，取值范围:[1~2000]	100
ipv6Address	否	String	IPv6地址的ID（多可用区类资源池暂不支持）	eip-5sdasd2gfh
publicIP	否	String	弹性公网IP的ID	eip-9jpeyl0frh
affinityGroup	否	String	云主机组ID，您可以调用affinityGroupID查看当前用户的云主机组列表	259b0c37-1044-41d8-989e
keyPairID	否	String	密钥对ID	c57d0626-8a82-407b-a910-b454907778c3
rootPassword	否	String	用户密码，满足以下规则：长度在8～30个字符；必须包含大写字母、小写字母、数字以及特殊符号中的三项；特殊符号可选：()`~!@#$%^&*_-+=｜{}[]:;'<>,.?/\且不能以斜线号 / 开头；不能包含3个及以上连续字符； Linux镜像不能包含镜像用户名（root）、用户名的倒序（toor）、用户名大小写变化（如RoOt、rOot等）； Windows镜像不能包含镜像用户名（Administrator）、用户名大小写变化（adminiSTrator等）	1qaz@WSX
cycleCount	否	Integer	订购时长	6
cycleType	否	String	订购周期类型，取值范围： MONTH表示按月， YEAR表示按年，最长订购周期为5年	MONTH
autoRenewStatus	否	Integer	是否自动续订，取值范围： 0：不续费 1：自动续费，按月购买：自动续订周期为1个月, 按年购买：自动续订周期为1年	1
userData	否	String	用户自定义数据,需要以Base64方式编码,需要以Base64方式编码,Base64编码后的长度限制为1-16384字符	ZWNobyBoZWxsbyBnb3N0YWNrIQ==

表 disks

参数	是否必填	参数类型	说明	示例
diskMode	否	String	云硬盘属性，取值范围: [FCSAN、ISCSI、VBD]，默认值为VBD	VBD
title	是	String	云硬盘名称，长度2~63,不支持中文	ebs.name
type	是	String	表示云硬盘类型，取值范围: SATA：普通IO， SAS：高IO， SSD：超高IO， SSD-genric：通用型SSD， FAST-SSD：极速型SSD	SATA
size	是	Integer	云硬盘容量大小单位为GiB，取值范围:[10-32768]	20

表 networkCardList

参数	是否必填	参数类型	说明	示例
title	否	String	长度2~32，支持拉丁字母、中文、数字、下划线、连字符，中文或英文字母开头，不能以http:或https:开头	net.name
fixedIP	否	String	内网IPv4地址	192.168.3.20
master	是	Boolean	是否主网卡，取值范围： true：主网卡， false：扩展网卡	true
subnetID	是	String	子网ID	a90eebf0-d798-5017-b9f0-9468bb2301c2

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码(800为成功，900为失败)	800
errorCode	String	业务细分码，为product.module.code三段式码，详见错误码说明	Openapi.PatternCheck.NotValid
message	String	失败时的错误描述，一般为英文描述	SUCCESS
description	String	失败时的错误描述，一般为中文描述	成功
returnObj	Object	成功时返回的数据		returnObj

表 returnObj

参数	参数类型	说明	示例
masterOrderID	String	主订单ID。调用方在拿到masterOrderID之后，可以使用materOrderID进一步确认订单状态及资源状态	235145e4489811eda8330242ac110002
masterOrderNO	String	订单号	20221010142913884246
masterResourceID	String	主资源ID	3cda4bf48cac42b8b7db3b279d2fc6fb
regionID	String	资源池ID，您可以调用regionID查看最新的天翼云资源池列表	81f7728662dd11ec810800155d307d5b

枚举参数

无

请求示例

请求url

无

请求头header

无

请求体body

{
	"clientToken": "ctapi-test-0719-1",
     "regionID": "bb9fdb42056f11eda1610242ac110002",
     "azName": "cn-huadong1-jsnj1A-public-ctcloud",
     "projectID": "0",
     "vmName": "ctapi-0719-1",
     "displayName": "ctapi-test-0719-1",
     "flavorID": "cc5fa4f7-faaf-7f39-a3c3-b763f81ef2b6",
     "imagePublic": 1,
     "imageID": "6e95ed90-b8b6-40ee-ae38-d851b6dc35e4",
     "syshdType": "SATA",
     "syshd": 40,
     "diskList": [{
         "diskMode": "VBD",
         "title": "ebs.dataDisk",
         "type": "SATA",
         "size": 10
     }],
     "vpc": "vpc-euu7edo58k",
     "onDemand": false,
     "secGroupList": ["sg-tolywxbe1f"],
     "networkCardList": [{
         "subnetID": "subnet-y8cofge5uj",
         "master": true}],
     "extIP": "1",
     "ipType": "ipv4",
     "bandWidth": 1,
     "affinityGroup": "904c9ee7-b0c6-26d9-963a-d15dd0eab35a",
     "keyPairID": "8da7e3b6-c16e-f303-5615-37db39cc8ae1",
     "rootPassword": "1qaz@WSX",
     "cycleType": "MONTH",
     "cycleCount": 1,
     "autoRenewStatus": 0,
     "userData": "Y3JlYXRlIGVjcyB0ZXN0IDA3MTk="
}

响应示例

{
	"returnObj": {
		"regionID": "81f7728662dd11ec810800155d307d5b",
		"masterOrderID": "107e901c449611ed8b6a0242ac110002",
		"masterResourceID": "34c7cc05a52b48eda0a84e34a82b346b",
		"masterOrderNO": "20221009163836430197"
    },
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

弹性云主机

弹性云主机

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码