创建实例
1. 接口描述
调用 CreateInstance 接口创建一台包年包月的实例。
- 实例创建成功后默认是关机状态，需要自行调用开机和修改密码。
- 预付费实例的购买会预先扣除本次实例购买所需金额，在调用本次接口前请确保账户余额充足。
- 本接口为异步接口，当创建实例请求下发成功后会返回一个实例 ID 和 RequestId，此时创建实例操作并未立即完成，在次期间实例的状态将会处于“PENDING”，实例创建结果可通过调用 DescribeInstance 接口查询，如果实例状态由“PENDING”变为“STOPPED”，则代表实例创建成功，“CREATE_FAIL”代表实例创建失败。
- 创建实例需要通过实名认证，您可以参见实名认证相关文档完成认证。
2. 请求参数
| 参数名 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| Action | String | 是 | 固定取值：CreateInstance |
| RegionCode | String | 是 | 实例所属的地域编码，您可以调用DescribeRegionConfig查看最新的地域列表 |
| ZoneCode | String | 是 | 实例所属的可用区编码，您可以调用DescribeZoneConfig查看可用区列表 |
| VSwitchUUID | String | 是 | 子网标识 |
| HostName | String | 否 | 实例名称，长度为2~128个英文或中文字符 |
| InstanceResourceUUID | String | 是 | 第三方实例ID，平台进行关联订单时使用 |
| InstanceChargeType | String | 是 | 付费方式，可能值: PRE_PAID 预付费 |
| SystemDiskCategory | String | 是 | 系统盘的云盘种类，可能值： CLOUD 普通云盘 CLOUD_EFFICIENCY 高效云盘 CLOUD_SSD SSD云盘 LOCAL_SSD SSD本地盘 LOCAL 普通本地盘 |
| SystemDiskSize | Integer | 是 | 系统盘大小,单位GB |
| ImageUUID | String | 是 | 镜像ID 系统镜像，您可以调用 DescribeImageConfig 查询当前地域下的系统镜像列表 自定义镜像，您可以调用 DescribeImages 查询当前地域下的自定义镜像列表 |
| InstanceType | String | 是 | 实例系列，您可以调用 DescribeProductConfig 查看您可购买的实例系列 |
| InstanceSpec | String | 是 | 实例规格，您可以调用 DescribeProductConfig 查看您可购买的实例规格 |
| Cpu | Integer | 是 | CPU 核心数 |
| Memory | Integer | 是 | 内存大小，单位：GB |
| NetworkType | String | 是 | 网络类型，取值范围: CLASSIC_NETWORK 经典网络 PRIVATE_NETWORK 私有网络 |
| Period | Integer | 是 | 购买资源时长 Period取值：1、2、3、4、5、6、7、8、9、12、24、36、48 |
| BillingCycle | String | 是 | 资源购买时长周期，取值范围: MONTH 月 |
| AutoRenew | String | 否 | 是否自动续费。取值范围: NONE 不开启自动续费 INFINITE 开启自动续费 |
| DataDiskList | String | 否 | 数据盘信息集合JSON字符串，参考数据结构：DataDiskInfo |
| EipSeries | String | 否 | 弹性公网IP系列，取值范围： Normal 普通型 Enetwork 网络增强型 默认取值：Normal |
| BandwidthType | String | 否 | 弹性公网IP线路类型，您可以调用 DescribeProductConfig 查看您可购买的弹性公网IP线路类型 |
| Bandwidth | Integer | 否 | 弹性公网IP带宽大小，单位Mbps |
| InternetChargeType | String | 否 | 弹性公网IP计费方式，可能取值： PAY_BY_BAND_WIDTH 按带宽计费 PAY_BY_TRAFFIC 按流量计费 |
| CidrBlock | String | 否 | 指定IP地址网段 |
| IpAddress | String | 否 | 指定IP地址，指定IP地址时CidrBlock为必传 |
| ClientToken | String | 是 | 用于保证请求的幂等性 |
3. 返回数据
| 参数名 | 类型 | 说明 |
|---|---|---|
| InstanceUUID | String | 实例ID |
| RequestId | String | 请求ID |
4. 示例
请求示例
https://openapi.kaopuyun.com/?SignatureVersion=1.0
&Action=CreateInstance
&Format=JSON
&SignatureNonce=fad368fd-b5e3-476b-903b-2ef34e0e9fba
&Version=2014-05-26
&AccessKeyId=hfWkfqG6a794
&Signature=IcyHYfUBWSzJauAbDaqniNSNE94=
&SignatureMethod=HMAC-SHA1
&Timestamp=2023-02-25T15:29:21Z
&RegionCode=cn-fuzhou-1
&ZoneCode=cn-fuzhou-1-a
&VSwitchUUID=vnet-x8sfa05erl
&InstanceResourceUUID=ecs-x8sfa05erl
&InstanceChargeType=PRE_PAID
&SystemDiskCategory=CLOUD
&SystemDiskSize=50
&ImageUUID=img-ecs-x8sfa05erl
&InstanceType=s1
&InstanceSpec=ecs.n1.xlarge
&Cpu=8
&Memory=16
&NetworkType=PRIVATE_NETWORK
&Period=1
&BillingCycle=MONTH
&ClientToken=fad368fd-b5e3-476b-903b
正常返回示例
{
"InstanceUUID":"ecs-jw000009ond8",
"RequestId":"742fbe80-0ea9-11eb-9b36-0208cb7f7896"
}
5错误码
| 错误码 | 错误信息 | |
|---|---|---|
| MissingParameter | RegionCode 参数不能为空 | |
| MissingParameter | ZoneCode 参数不能为空 | |
| MissingParameter | VSwitchUUID 参数不能为空 | |
| MissingParameter | InstanceResourceUUID 参数不能为空 | |
| MissingParameter | InstanceChargeType 不能为空 | |
| MissingParameter | SystemDiskCategory 参数不能为空 | |
| MissingParameter | SystemDiskSize 参数不能为空 | |
| MissingParameter | ImageUUID 参数不能为空 | |
| MissingParameter | InstanceType 参数不能为空 | |
| MissingParameter | InstanceSpec 参数不能为空 | |
| MissingParameter | CPU 参数不能为空 | |
| MissingParameter | Memory 参数不能为空 | |
| MissingParameter | NetworkType 参数不能为空 | |
| MissingParameter | Period 参数不能为空 | |
| MissingParameter | BillingCycle 参数不能为空 | |
| MissingParameter | IpCidrBlock 参数不能为空 | |
| ValueNotSupported | BillingCycle 参数不合法 | |
| ValueNotSupported | SystemDiskCategory 参数不合法 | |
| ValueNotSupported | NetworkType 参数不合法 | |
| ValueNotSupported | InstanceChargeType 参数不合法 | |
| ValueNotSupported | BandwidthType 参数不合法 | |
| ValueNotSupported | InternetChargeType 参数不合法 | |
| ValueNotSupported | AutoRenew 参数不合法 | |
| InvalidEcsConfigNotSupported | 云服务器配置不合法 | |
| NoAvailableBandwidthTypeConfig | 无可用线路类型配置 | |
| NoAvailableIp | 无可用IP | |
| AccountBalnceNotEnough | 账户余额不足 | |
| AccountNotRealnameAuth | 账户未实名认证 | |
| CreateInstanceFail | 创建实例失败:xxx |