云主机

产品文档

云主机

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

describeInstanceTemplates

描述

查询启动模板列表

请求方式

GET

请求地址

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

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

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 1 页码;默认为1
pageSize Integer False 20 分页大小;默认为20;取值范围[10, 100]
filters Filter[ ] False name - 启动模板名称,模糊匹配,支持多个
instanceTemplateId - 启动模板ID,精确匹配,支持多个

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤条件的名称
operator String False 过滤条件的操作符,默认eq
values String[ ] True 过滤条件的值

返回参数

名称 类型 描述
result Result
requestId String

Result

名称 类型 描述
instanceTemplates InstanceTemplate[ ]
totalCount Number

InstanceTemplate

名称 类型 描述
id String 启动模板ID
name String 启动模板名称
description String 启动模板描述
instanceTemplateData InstanceTemplateData 启动模板的数据
ags Ag[ ] 关联的高可用组(ag)信息
createdTime String 创建时间

Ag

名称 类型 描述
name String 高可用组名称
id String 高可用组id

InstanceTemplateData

名称 类型 描述
instanceType String 实例规格
vpcId String 主网卡所属VPC的ID
imageId String 镜像ID
includePassword Boolean 启动模板中是否包含自定义密码,true:包含密码,false:不包含密码
systemDisk InstanceTemplateDiskAttachment 系统盘信息
dataDisks InstanceTemplateDiskAttachment[ ] 数据盘信息,本地盘(local类型)做系统盘的云主机可挂载8块数据盘,云硬盘(cloud类型)做系统盘的云主机可挂载7块数据盘。
primaryNetworkInterface InstanceTemplateNetworkInterfaceAttachment 主网卡信息
elasticIp InstanceTemplateElasticIp 主网卡主IP关联的弹性IP规格
keyNames String[ ] 密钥对名称;当前只支持一个

InstanceTemplateElasticIp

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

InstanceTemplateNetworkInterfaceAttachment

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

InstanceTemplateNetworkInterface

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

InstanceTemplateDiskAttachment

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

InstanceTemplateDisk

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

返回码

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