接口功能介绍
本接口提供用户在专属云中创建一台按量付费的云主机的功能
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
计费模式:确认开通云主机的计费模式,详细查看计费模式
地域选择:选择要创建云主机的专属云的资源池
产品选型:购买弹性云主机前,请先阅读规格说明了解弹性云主机的选型基本信息,并通过查询一个或多个云主机规格资源接口,获取当前资源池可用云主机规格信息
网络规划:规划云主机的网络环境,详细查看弹性云主机-网络
注意事项:
成本估算:了解云主机的计费项
用户配额:确认个人在不同资源池下资源配额,可以通过用户配额查询接口进行查询
异步接口:该接口为异步接口,下单过后会拿到主订单ID(masterOrderID),后续可以调用根据masterOrderID查询云主机ID,使用主订单ID来对订单情况与开通成功后的资源ID进行查询
单台创建:当前接口只能创建单台云主机
监控安装:在云服务器创建成功后,3-5分钟内将完成详细监控Agent安装,即开启云服务器CPU,内存,网络,磁盘,进程等指标详细监控,若不开启,则无任何监控数据。
接口约束
1. 目前不支持预付费账户创建按需付费类型云主机
2. 专属云内创建云主机均为按需类型云主机
3. 自动分配弹性IP(extIP="1")时,需要填写弹性IP版本(ipVersion)与带宽大小(bandwidth);使用已有的弹性IP(extIP="2")时,需要填写弹性IP的版本(ipVersion)和对应弹性IP的ID(eipID或ipv6AddressID)
4. 挂载网卡时,子网与虚拟私有云存在对应关系,确保子网属于当前虚拟私有云
URI
POST /v4/dec/create-instance
路径参数
无
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 | 云主机名称。不同操作系统下,云主机名称规则有差异。 Windows:长度为2-15个字符,允许使用大小写字母、数字或连字符(-)。不能以连字符(-)开头或结尾,不能连续使用连字符(-),也不能仅使用数字; 其他操作系统:长度为2-64字符,允许使用点(.)分隔字符成多段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾,也不能仅使用数字 |
ecm-3300 | |
displayName | 是 | String | 云主机显示名称,长度为2~63字符 | ecm-3300 | |
flavorID | 是 | String | 云主机规格ID,您可以查看规格说明了解弹性云主机的选型基本信息 获取: 查 查询一个或多个云主机规格资源 注:同一规格名称在不同资源池不同可用区的规格ID是不同的,调用前需确认规格ID是否归属当前资源池,多可用区资源池确认是否归属当前可用区 |
0824679a-dc86-47dc-a0d3-9c330928f4f6 | |
decHostID | 否 | String | 专属宿主机ID,获取: 查 查询专属宿主机列表 |
73f321ea-62ff-11ec-a8bc-005056898fe0 | |
decTypeID | 否 | String | 专属云存储ID | 32af90b5-664c-41c4-bc59-0f88b39eebc2 | |
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 | |
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 | |
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 | |
monitorService | 否 | Boolean | 监控参数,支持通过该参数指定云主机在创建后是否开启详细监控,取值范围: false(不开启), true(开启) 若指定该参数为true或不指定该参数,云主机内默认开启最新详细监控服务。 若指定该参数为false,默认公共镜像不开启最新监控服务;私有镜像使用镜像中保留的监控服务。 说明:仅部分资源池支持monitorService参数,详细请参考监控Agent概览。 |
true |
表 dataDiskList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskMode | 否 | String | 云硬盘属性,取值范围: FCSAN(光纤通道协议的SAN网络), ISCSI(小型计算机系统接口), VBD(虚拟块存储设备) 您可以查看磁盘模式及使用方法 注:默认为VBD |
VBD | |
diskName | 是 | String | 云硬盘名称,长度限制2~63字符,不支持中文 | ebs.name | |
diskType | 是 | String | 云硬盘类型,取值范围: SATA(普通IO), SAS(高IO), SSD(超高IO), SSD-genric(通用型SSD), FAST-SSD(极速型SSD) 您可以查看磁盘类型及性能介绍磁盘类型相关信息 |
SATA | |
diskSize | 是 | Integer | 磁盘容量,单位为GB,取值范围:[10, 32768] | 20 |
表 networkCards
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nicName | 否 | String | 长度2~32,支持拉丁字母、中文、数字、下划线、连字符,中文或英文字母开头,不能以http:或https:开头 | net.name | |
fixedIP | 否 | String | 内网IPv4地址,注:不可使用已占用IP | 192.168.3.20 | |
isMaster | 是 | Boolean | 是否主网卡,取值范围: true(表示主网卡), false(表示扩展网卡) 注:只能含有一个主网卡 |
true | |
subnetID | 是 | String | 子网ID,您可以查看基本概念来查找子网的相关定义 获取: 查 查询子网列表 创 创建子网 注:在多可用区类型资源池下,subnetID通常以“subnet-”开头,非多可用区类型资源池subnetID为uuid格式 |
a90eebf0-d798-5017-b9f0-9468bb2301c2 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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:创建一台云主机,配置各项内容,不使用弹性公网IP
在专属云内,系统盘选普通IO类型、大小40GB,并增加20GB普通IO类型数据盘。
规格为s7.small.1,镜像为CentOS8.0 64位,并附带副网卡指定其名称和内网IP地址,并配置使用指定安全组,不使用弹性公网IP。
创建到指定专属宿主机上,并加入安全组,绑定密钥对
{
"clientToken": "please_create_your_own_clientToken_not_use_dec_create_example_01",
"instanceName": "api-test01",
"displayName": "create-01",
"imageType": 1,
"bootDiskType": "SATA",
"bootDiskSize": 40,
"onDemand": true,
"extIP": "0",
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"flavorID": "0457fe14-6ffe-e739-87ad-93e43fc6dbfa",
"imageID": "d39aba04-2470-4eea-acdc-10cb4f962588",
"vpcID": "vpc-gg2ov4ryo5",
"decHostID": "53cbad26-c4bc-34ff-2e89-80fc0940437f",
"networkCardList": [{
"subnetID": "subnet-5zt2og2t3h",
"isMaster": true
}, {
"subnetID": "subnet-975wansb47",
"isMaster": false,
"nicName": "api-test1031",
"fixedIP": "192.168.1.8"
}],
"dataDiskList": [{
"diskMode": "VBD",
"diskName": "disk-01",
"diskSize": 20,
"diskType": "SATA"
}],
"secGroupList": ["sg-1nni47y963"],
"affinityGroupID": "daccb1e1-e2fd-a380-1b37-d9d6f581395e",
"keyPairID": "d0d9d373-3ffa-17fc-38c9-93283a1eb800",
"userPassword": "zxTest1031"
}
示例2:指定已有公网IP,创建云主机
在专属云内,系统盘选普通IO类型、大小40GB,指定ipv4类型弹性公网,
规格为s7.small.1,镜像为Ubuntu 18.04 64位。
{
"clientToken": "please_create_your_own_clientToken_not_use_dec_create_example_02",
"instanceName": "api-02",
"displayName": "create-02",
"imageType": 1,
"bootDiskType": "SATA",
"bootDiskSize": 40,
"onDemand": true,
"extIP": "2",
"ipVersion": "ipv4",
"eipID": "eip-trwi2vk023",
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"flavorID": "0457fe14-6ffe-e739-87ad-93e43fc6dbfa",
"imageID": "26ec204c-ebe5-47b9-bff9-32da77026228",
"vpcID": "vpc-gg2ov4ryo5",
"decHostID": "53cbad26-c4bc-34ff-2e89-80fc0940437f",
"networkCardList": [{
"subnetID": "subnet-5zt2og2t3h",
"isMaster": true
}]
}
示例3:自动分配公网IP,创建云主机
在专属云内,系统盘选普通IO类型、大小40GB,自动分配带宽大小为2Mbit/s的弹性公网,
规格为s7.small.1,镜像为Ubuntu 18.04 64位。
{
"clientToken": "please_create_your_own_clientToken_not_use_dec_create_example_03",
"instanceName": "api-03",
"displayName": "create-03",
"imageType": 1,
"bootDiskType": "SATA",
"bootDiskSize": 40,
"onDemand": true,
"extIP": "1",
"ipVersion": "ipv4",
"bandwidth": 2,
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"flavorID": "0457fe14-6ffe-e739-87ad-93e43fc6dbfa",
"imageID": "d39aba04-2470-4eea-acdc-10cb4f962588",
"vpcID": "vpc-gg2ov4ryo5",
"decHostID": "53cbad26-c4bc-34ff-2e89-80fc0940437f",
"networkCardList": [{
"subnetID": "subnet-5zt2og2t3h",
"isMaster": true
}]
}
响应示例
{
"returnObj": {
"masterResourceID": "39559b25eabf455481aa9e3882d3b0a7",
"masterOrderNO": "20221202173339078653",
"regionID": "ef901a5734964ce29eedac918c4716a3",
"masterOrderID": "0ea2d572722311eda5fb0242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码