云主机

产品文档

云主机

帮助中心 > OpenAPI & SDK > 云主机 > createInstanceTemplate

createInstanceTemplate

描述

创建一个指定参数的启动模板,启动模板中包含创建云主机时的大部分配置参数,避免每次创建云主机时的重复性工作。
如果是使用启动模板创建云主机,如果指定了某些参数与模板中的参数相冲突,那么新指定的参数会替换模板中的参数。
如果是使用启动模板创建云主机,如果指定了镜像ID与模板中的镜像ID不一致,那么模板中的dataDisks参数会失效。
如果使用高可用组(Ag)创建云主机,那么Ag所关联的模板中的参数都不可以被调整,只能以模板为准。

请求方式

POST

请求地址

https://vm.jdcloud-api.com/v1/regions/{regionId}/instanceTemplates

名称 类型 是否必需 默认值 描述
regionId String True 地域ID

请求参数

名称 类型 是否必需 默认值 描述
instanceTemplateData InstanceTemplateSpec True 启动模板的数据
name String True 启动模板的名称,参考公共参数规范
description String False 启动模板的描述,参考公共参数规范

InstanceTemplateSpec

名称 类型 是否必需 默认值 描述
instanceType String True 实例规格,可查询DescribeInstanceTypes接口获得指定地域或可用区的规格信息。
imageId String True 镜像ID,可查询DescribeImages接口获得指定地域的镜像信息。
password String False 密码,参考公共参数规范
keyNames String[ ] False 密钥对名称;当前只支持一个
elasticIp InstanceTemplateElasticIpSpec False 主网卡主IP关联的弹性IP规格
primaryNetworkInterface InstanceTemplateNetworkInterfaceAttachmentSpec True 主网卡配置信息
systemDisk InstanceTemplateDiskAttachmentSpec True 系统盘配置信息
dataDisks InstanceTemplateDiskAttachmentSpec[ ] False 数据盘配置信息

InstanceTemplateDiskAttachmentSpec

名称 类型 是否必需 默认值 描述
diskCategory String False 磁盘分类,取值为本地盘(local)或者数据盘(cloud)。
系统盘支持本地盘(local)或者云硬盘(cloud)。系统盘选择local类型,必须使用localDisk类型的镜像;同理系统盘选择cloud类型,必须使用cloudDisk类型的镜像。
数据盘仅支持云硬盘(cloud)。
autoDelete Boolean False 随云主机一起删除,删除主机时自动删除此磁盘,默认为true,本地盘(local)不能更改此值。
如果云主机中的数据盘(cloud)是包年包月计费方式,此参数不生效。
如果云主机中的数据盘(cloud)是共享型数据盘,此参数不生效。
cloudDiskSpec InstanceTemplateDiskSpec False 数据盘规格
deviceName String False 数据盘逻辑挂载点,取值范围:vda,vdb,vdc,vdd,vde,vdf,vdg,vdh,vdi,vmj,vdk,vdl,vdm
noDevice Boolean False 排除设备,使用此参数noDevice配合deviceName一起使用。
创建模板:如deviceName:vdb、noDevice:true,则表示镜像中的数据盘vdb不参与创建主机。

InstanceTemplateDiskSpec

名称 类型 是否必需 默认值 描述
diskType String False 云硬盘类型,取值为ssd、premium-hdd、hdd.std1、ssd.gp1、ssd.io1
diskSizeGB Integer False 云硬盘大小,单位为 GiB;ssd 类型取值范围[20,1000]GB,步长为10G,premium-hdd 类型取值范围[20,3000]GB,步长为10G,hdd.std1、ssd.gp1、ssd.io1 类型取值范围[20-16000]GB,步长为10GB
snapshotId String False 用于创建云硬盘的快照ID

InstanceTemplateNetworkInterfaceAttachmentSpec

名称 类型 是否必需 默认值 描述
deviceIndex Integer False 设备Index;主网卡的index必须为1;当前仅支持主网卡
autoDelete Boolean False 指明删除实例时是否删除网卡,默认true;当前只能是true
networkInterface InstanceTemplateNetworkInterfaceSpec True 网卡接口规范;此字段当前必填

InstanceTemplateNetworkInterfaceSpec

名称 类型 是否必需 默认值 描述
subnetId String True 子网ID
securityGroups String[ ] False 安全组ID列表
sanityCheck Integer False PortSecurity,取值为0或者1,默认为1

InstanceTemplateElasticIpSpec

名称 类型 是否必需 默认值 描述
bandwidthMbps Integer True 弹性公网IP的限速(单位:MB)
provider String False IP服务商,取值为BGP,nonBGP
chargeMode String True 计费类型,支持按带宽计费(bandwith),按流量计费(flow)

返回参数

名称 类型 描述
result Result
requestId String

Result

名称 类型 描述
instanceTemplateId String

返回码

返回码 描述
200 OK
400 Invalid parameter
401 Authentication failed
404 Not found
429 Quota exceeded
500 Internal server error
503 Service unavailable
更新时间:2019-07-22 11:54:52