产品与服务
解决方案
定价
文档
云市场
开发者
了解金山云
招标公告

热门搜索

云服务器 弹性IP 对象存储 IAM 账号管理 账单
控制台
备案
全部文档
当前文档

热搜词推荐

云服务器 虚拟私有网络 边缘节点计算 对等连接

共搜索到 0 条结果

暂无内容

如果没有找到您期望的内容，请尝试其他搜索词

文档中心

云服务器(KEC)

查看更多结果
未找到含当前关键字的文档标题
页面目录
全部展开全部收起
未找到含该关键词的产品
文档中心 云服务器(KEC) API文档 实例启动模版 创建实例启动模版

创建实例启动模版

接口说明

实例启动模板中可以储存除密码外的任意创建实例配置信息，例如实例所属地域、镜像ID、套餐规格、安全组ID和公网带宽等。如果模板中没有指定某一实例配置，您需要在创建实例时为实例指定该配置。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
参数名称
类型
必填
描述
Action String 是
公共参数，本接口取值：CreateModel。
Version String 是
公共参数，本接口取值：2016-03-04。
ImageId String 是

镜像ID 标准UUID格式，形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

示例值：13536cc1-0dbd-4741-87d3-f7abbb0db329
InstanceType String 否

实例套餐类型，如果调用时未指定实例套餐类型，默认值为I1.1A
实例套餐类型有效值具体套餐信息参考实例套餐类型定义

示例值：C1.1B
DataDiskGb Int 否

数据卷容量，单位GB，容量限制依据实例套餐类型定义变化，如果调用时未指定，则为相应实例套餐类型最小值。InstanceType为通用型主机时，此参数不生效。

示例值：-
SubnetId String 否

VPC环境下的子网ID，绑定到主网卡。 标准UUID格式，形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

示例值：-
DataDisk.N Object 否

数据盘（云盘）的类型，数据盘n的类型，n 的取值范围为 [1, 8]。只支持I2、I2联网增强、N1、N2、N3、S3和I3。DataDisk.n.Type与DataDisk.n.Size必须都填写才有效。 SSD3.0，EHDD

示例值：-
Type String 否
数据盘（云盘）的类型，数据盘n的类型，n 的取值范围为 [1, 8]。只支持I2、I2联网增强、N1、N2、N3、S3和I3。DataDisk.n.Type与DataDisk.n.Size必须都填写才有效。 SSD3.0，EHDD
示例值：-
Size Int 否
第 n 个数据盘（云盘）的容量大小，n 的取值范围为 [1, 8]。只支持I2、I2联网增强、N1、N2、N3、S3和I3。DataDisk.n.Type与DataDisk.n.Size必须都填写才有效。 [10，16000]
示例值：20
DeleteWithInstance Boolean 否
数据盘是否随实例释放，默认值为false true：实例释放时，这块磁盘随实例一起释放。<br>false：实例释放时，这块磁盘保留不释放。
示例值：-
SnapshotId String 否

云盘快照id

SnapshotName String 否
KeepImageLogin Boolean 否

保留镜像设置登录。该参数只对使用自定义镜像有效。当该值填写为true，默认InstancePassword参数无效。该参数与InstancePassword必须填写一个。 true/false，默认值为false

示例值：-
KeyId String 否

秘钥ID，非必填项，无默认值，若填写则默认InstancePassword参数无效，当用户选择other-linux镜像时，不支持该登录方式。若使用的自定义镜像，KeepImageLogin 为true时，默认keyId和InstancePassword参数无效。

示例值：-
ChargeType String 是

计费类型，调用时需要明确指定，无默认值。 Monthly(包年包月）、Daily（按量付费（按日月结）)、 HourlyInstantSettlement（按量付费）、Spot（竞价型实例）

示例值：-
PurchaseTime Int 否

购买时长，单位月。 当计费类型为Monthly（包年包月）时，有效值1-36；其他计费类型时，强制要求参数值为0。

示例值：1
SecurityGroupId.N String 是

实例绑定的安全组，目前仅支持绑定一个安全组。
标准UUID格式，形如^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

示例值：-
PrivateIpAddress String 否

私有IP地址，指定子网IP地址范围内的任意有效值，代表实例的主IP地址，只能选择一个，绑定到主网卡；如果未指定该参数，系统自动从有效地址池中随机选取一个。 标准IP地址格式

示例值：-
InstanceName String 否

实例名称，如果未指定，则自动生成，形如KSC-IN-[A-Z0-9]{10}。 最短2字符，最长64字符，支持中英文

示例值：test_2
InstanceNameSuffix String 否

实例名称后缀，InstanceName参数如果缺省，此参数不生效；当大于1台的批量创建主机，后缀编号自动+1，例如后缀输入5，主机名输入"host"，批量3台，则生成的三台主机名分别为：“host-5”、“host-6”、“host-7”。 0到9999,默认值为空

示例值：1
SriovNetSupport String 否

联网增强属性
该参数需要满足以下两个条件：
1.IO优化型I1，计算优化型C1，IO优化型I2的8C以上套餐
2.使用的是金山云提高的标准镜像或者通过金山云标准镜像开机的实例再制作的自定义镜像

示例值：-
ProjectId Long 否

实例所属项目ID 账户有权限的项目ID，0为默认项目,默认值为默认项目

示例值：-
DataGuardId String 否

容灾分组ID

示例值：-
AddressBandWidth Int 否

弹性IP的带宽

示例值：-
LineId String 否

弹性IP的链路类型的ID

示例值：-
AddressChargeType String 否

弹性IP的计费类型 Monthly：包年包月，有到期时间，只能升带宽
Peak：按量付费（月峰值），无到期时间，可升降带宽
Daily：按量付费（按日月结），无到期时间，可升降带宽
TrafficMonthly：按量付费（流量月结），无到期时间，可升降带宽
DailyPaidByTransfer：按量付费（流量），无到期时间，可升降带宽
HourlyInstantSettlement：按量付费，无到期时间，可升降带宽

示例值：-
AddressPurchaseTime Int 否

弹性IP的购买时长，只有购买包年包月弹性IP时不可缺省。

示例值：-
AddressProjectId String 否

弹性IP项目的ID

示例值：-
ModelName String 是

实例启动模版名称，不允许重复 ModelTest001

示例值：-
FailureAutoDelete Boolean 否

开机失败是否自动删除，默认值是false

SystemDisk Object 否
DiskType String 否

不能给默认值，不传默认按价格体系配置systemDisk属性中第一个创建

DiskSize String 否

系统盘内存大小，最小值为0，最大值为500

HostName String 否

操作系统内部的计算机名

HostNameSuffix String 否

创建多台实例时为HostName增加有序后缀，有序后缀从1增加，例如host-1

UserData String 否

用户自定义数据

NetworkInterface.N Object 否
SubnetId String 否

辅网卡的子网id不创建辅网卡时非必填，创建辅网卡时必填

SecurityGroupId.N String 否

辅网卡的安全组id不创建辅网卡时非必填，创建辅网卡时必填

PrivateIpAddress String 否

辅网卡的内网ip,创建辅网卡传了按传的ip开机，不传自动分配

Tag.N Object 否
Key String 否
Id Long 否
Value String 否
AllocateAddress Boolean 否

购买EIP，true or false；传true即为购买EIP，下面关于EIP的参数生效；传false为稍后购买，下面的EIP参数不生效

IsDistributeIpv6 Boolean 否

是否支持ipV6

Mem String 否

内存

Cpu String 否

cpu

IamRoleName String 否

Iam角色名称

AssembledImageDataDiskType String 否

整机镜像数据盘类型

LocalVolumeSnapshotId String 否

本地盘快照id

SyncTag Boolean 否

是否同步ebs标签

返回参数

参数名称
类型
描述
RequestId String
示例值：8dc457b5-4961-4425-8473-05e885053736002
ModelId String
示例值：99a7ed43-a962-46d6-a24a-277b7c402775
ModelName String
示例值：openapi_test_model_1694642952648

请求示例

curl -X GET|POST
'http://kec.api.ksyun.com/?Action=CreateModel&Version=2016-03-04'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/x-www-form-urlencoded'
-H 'host: kec.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d 'ImageId=xxx&InstanceType=xxx&DataDiskGb=xxx&SubnetId=xxx&DataDisk.N.Type=xxx&DataDisk.N.Size=xxx&DataDisk.N.DeleteWithInstance=xxx&DataDisk.N.SnapshotId=xxx&DataDisk.N.SnapshotName=xxx&KeepImageLogin=xxx&KeyId=xxx&ChargeType=xxx&PurchaseTime=xxx&SecurityGroupId.N=xxx&PrivateIpAddress=xxx&InstanceName=xxx&InstanceNameSuffix=xxx&SriovNetSupport=xxx&ProjectId=xxx&DataGuardId=xxx&AddressBandWidth=xxx&LineId=xxx&AddressChargeType=xxx&AddressPurchaseTime=xxx&AddressProjectId=xxx&ModelName=xxx&FailureAutoDelete=xxx&SystemDisk.DiskType=xxx&SystemDisk.DiskSize=xxx&HostName=xxx&HostNameSuffix=xxx&UserData=xxx&NetworkInterface.N.SubnetId=xxx&NetworkInterface.N.SecurityGroupId.N=xxx&NetworkInterface.N.PrivateIpAddress=xxx&Tag.N.Key=xxx&Tag.N.Id=xxx&Tag.N.Value=xxx&AllocateAddress=xxx&IsDistributeIpv6=xxx&Mem=xxx&Cpu=xxx&IamRoleName=xxx&AssembledImageDataDiskType=xxx&LocalVolumeSnapshotId=xxx&SyncTag=xxx'

返回示例

JSON格式

{
"RequestId":"8dc457b5-4961-4425-8473-05e885053736002",
"ModelId":"99a7ed43-a962-46d6-a24a-277b7c402775",
"ModelName":"openapi_test_model_1694642952648"
}

错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码

错误码
错误信息
Http状态码
描述
SecurityGroupIdDuplicate暂无400暂无
SubnetInvalidParameterValueAn invalid or out-of-range value was supplied for the "Subnet"([{0}]) parameter.400“子网”([{0}])参数的取值无效或者超出有效范围
DataGuardIdInvalidDataGuardId is invalid400容灾分组ID无效
InstanceTypeInvalidParameterValueAn invalid or out-of-range value was supplied for the "InstanceType" parameter.400“实例套餐类型”参数的取值无效或者超出有效范围
ChargeTypeInvalidParameterValueAn invalid or out-of-range value was supplied for the "ChargeType" parameter.400“计费类型”参数的取值无效或者超出有效范围
ImageIdInvalidParameterValueAn invalid or out-of-range value was supplied for the "ImageId" parameter.400“镜像ID”参数的取值无效或者超出有效范围
SriovNetSupportInvalidParameterValue"An invalid or out-of-range value was supplied for the "SriovNetSupport" parameter."400“联网增强”参数的取值无效或者超出有效范围
ParameterLimitExceeded暂无400暂无
AssembledImageDataDiskTypeInvalidForLocalImageLocalimage can only create SSD3.0 volume.400极速可用整机镜像只支持开SSD3.0的云盘
InstanceNameInvalidParameterValueAn invalid or out-of-range value was supplied for the "InstanceName" parameter.400“实例名称”参数的取值无效或者超出有效范围
AddressChargeTypeInvalidParameterValueAn invalid or out-of-range value was supplied for the "AddressChargeType" parameter.400“弹性IP的计费类型”参数的取值无效或者超出有效范围
AssembledImageDataDiskTypeInvalidAssembledImageDataDiskType is Invalid.400整机镜像数据盘类型传参错误
DataDiskGbInvalidParameterValueAn invalid or out-of-range value was supplied for the "DataDiskGb" parameter.400“数据卷容量”参数的取值无效或者超出有效范围
InstanceTypeNotSupport暂无400暂无
SecurityGroupIdInvalidSecurity group id is invalid400安全组ID无效
KeepImageLoginInvalidParameterValueAn invalid or out-of-range value was supplied for the "KeepImageLogin" parameter.400“保留镜像设置”参数的取值无效或者超出有效范围
ModelNameInvalidParameterValueAn invalid or out-of-range value was supplied for the "ModelName" parameter.400模版名称参数值无效
PrivateIpAddressInvalidParameterValueAn invalid or out-of-range value was supplied for the "PrivateIpAddress" parameter.400“私有IP地址”参数的取值无效或者超出有效范围
DedicatedClusterIdInvalidParameterValue暂无400暂无
InvalidParameter.TagKeyDuplicatetag key duplicate400标签key重复
ModelNameAlreadyExistsThe "ModelName" already exists.400模版名称参数值无效，不支持重名！
VMCountGreaterThanDataGuardCountCreate instance fail, because Data Guard Groups ({0}) has insufficient room400创建失败，容灾组({0})的可用容量不足，请选择其他容灾组
TrustCanNotAttachEipInstance under Trust VPC are not allowed to attach EIP.400互信vpc下的云主机不允许绑定eip
上一篇：实例启动模版
下一篇：删除实例启动模版
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
电话咨询
400-1070-808
在线客服
专业人工服务，为您快速解决上云服务
提交工单
产品问题、技术问题及常见问题快速
聆听反馈
您的建议我们会及时处理/反馈，非常快
关于金山云
了解金山云 官网公告 投资者关系 联系我们 法律条款 合规性 白皮书 廉洁举报 诚聘英才
服务与支持
在线客服 注册认证 文档中心 备案服务 资源包管理 网上举报 隐私举报
热门产品
云服务器 数据库 对象存储 CDN 弹性IP 裸金属服务器
账户管理
管理控制台 账号管理 实名认证 订单管理 资源目录 索取发票 充值付款 提交工单

7x24小时服务

免费备案

建议反馈

专家服务
咨询热线
400-1070-808
在线客服
一 键 开 启 云 上 生 活 一 键 开 启 云 上 生 活
TRUSTe
©北京金山云网络技术有限公司 2022 Ksyun All Rights Reserved Kingsoft Corp.
京ICP证120829号  京B2-20180585   京ICP备 12032080号    京公网安备11010802017204号