接口功能介绍
在专属云中创建一台按量付费的云主机
接口约束
无
URI
POST /v4/dec/ecs-create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,其他请求参数相同时,则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | bb9fdb42056f11eda161024aac110002 | |
azName | 是 | String | 可用区名称。您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | cn-huadong1-jsnj1A-public-ctcloud | |
vmName | 是 | String | 云主机名称。不同操作系统下,云主机名称规则有差异。 Windows:长度为2~15个字符,允许使用大小写字母、数字或连字符(-)。不能以连字符(-)开头或结尾,不能连续使用连字符(-),也不能仅使用数字; 其他操作系统:长度为2-64字符,允许使用点(.)分隔字符成多段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾,也不能仅使用数字。 |
ecm-3300 | |
displayName | 是 | String | 云主机显示名称,长度为2-63字符 | ecm-3300 | |
flavorID | 是 | String | 云主机规格ID,您可以调用flavorID查看最新的天翼云具体资源池的云主机规格列表 | 0824679a-dc86-47dc-a0d3-9c330928f4f6 | |
decHostUUID | 否 | String | 专属云宿主机ID | 73f321ea-62ff-11ec-a8bc-005056898fe0 | |
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 | 系统盘大小单位为GiB,取值范围[40-2048] | 40 | |
diskList | 否 | Array of Objects | 数据盘 | disks | |
vpc | 是 | String | 虚拟私有云ID | vpc-v0uqqxq1kv | |
secGroupList | 否 | Array of Strings | 安全组ID列表 | ["202ca2d2-273a-5995-873b-03731212c8e4"] | |
networkCardList | 是 | Array of Objects | 网卡列表 | networkCards | |
extIP | 是 | String | 表示是否使用弹性公网IP,取值范围: 0:不使用, 1:自动分配, 2:使用已有 |
2 | |
ipType | 否 | String | 表示弹性IP版本,取值范围: ipv4:v4地址 ipv6:v6地址 |
ipv4 | |
bandWidth | 否 | Integer | 带宽大小单位为Mbit/s,取值范围:[1~2000] | 100 | |
ipv6Address | 否 | String | IPv6地址ID | eip-5sdasd2gfh | |
publicIP | 否 | String | 弹性公网IP的ID | eip-9jpeyl0frh | |
affinityGroup | 否 | String | 云主机组ID | 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 |
表 disks
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskMode | 否 | String | 云硬盘属性,取值范围: [VBD],默认值为VBD | VBD | |
title | 是 | String | 云硬盘名称 ,长度2~63,不支持中文 | disk-xx | |
diskType | 否 | String | 表示云硬盘数据类型 ,取值范围: data:数据盘, 默认值为data |
data | |
type | 是 | String | 云硬盘类型,取值范围: SATA:普通IO SAS:高IO SSD:超高IO SSD-genric:通用型SSD FAST-SSD:极速型SSD |
SATA | |
size | 是 | Integer | 磁盘容量大小单位为GB,取值范围[10-32768] | 20 |
表 networkCards
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
title | 否 | String | 长度2~32,支持拉丁字母、中文、数字、下划线、连字符,中文或英文字母开头,不能以http:或https:开头 | nic-xxx | |
fixedIP | 否 | String | 内网IPv4地址 | 192.168.1.1 | |
master | 是 | Boolean | 是否主网卡,取值范围: true:主网卡, false:扩展网卡 |
true | |
subnetID | 是 | String | 子网ID | subnet-bzdqf5ujby |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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 | 81f7728662dd11ec810800155d307d5b |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda161024aac110002",
"azName": "cn-huadong1-jsnj1A-public-ctcloud",
"decHostUUID": "96f01e15-4504-40d3-fe87-65f627cf340e",
"vmName": "ghy-dec-openapi-test2",
"displayName": "ghy-dec-openapi-test2",
"flavorID": "8313e8d3-f4ea-f9fa-e9c0-63b281d18838",
"imagePublic": 1,
"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08",
"vpc": "vpc-v0uqqxq1kv",
"syshdType": "SAS",
"syshd": 40,
"extIP": "0",
"secGroupList": [
"sg-mu39b23x9z"
],
"networkCardList": [
{
"title": "ecm.mainCard",
"subnetID": "subnet-bzdqf5ujby",
"master": true
}
],
"clientToken": "fc6fa0de-ebe7-4168-9ea2-9c987c4705f5"
}
响应示例
{
"returnObj": {
"masterResourceID": "39559b25eabf455481aa9e3882d3b0a7",
"masterOrderNO": "20221202173339078653",
"regionID": "ef901a5734964ce29eedac918c4716a3",
"masterOrderID": "0ea2d572722311eda5fb0242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码