查询启动模板详情

接口说明


查询实例启动模板详情。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

GET https://ecloud.10086.cn/api/openapi-instance/v4/describe-launch-template

请求参数

Query

参数名称
类型
必填
描述
launchTemplateId
string
是

启动模板 ID。您可以通过查询启动模板列表获取信息。

请求示例

GET https://ecloud.10086.cn/api/openapi-instance/v4/describe-launch-template

返回参数

返回码:200
OK
参数名称
类型
描述
body
InstanceTemplate

请求成功时返回的数据。

createdTime
string(date-time)

模板创建时间

instanceTemplateData
InstanceTemplateCreateInfo

模板具体配置信息。

zoneId
string

可用区ID。

launchTemplateName
string

模板名称。长度为2 - 64个字符,以大小写字母开头,可包含数字、点号(.)、下划线(_)或连字符(~)。

launchTemplateDescription
string

模板描述。长度不超过128个字符。

imageId
string

镜像ID。

flavorName
string

规格名称。

groupId
string

关联群组ID。

chargeMode
string

付费方式。取值范围:

  • YEAR:包年。
  • MONTH:包月。
  • HOUR:按量。

默认值:HOUR。

duration
integer(int32)

订购时长(月/年),单位由chargeMode指定。
取值范围:

  1. chargeMode=HOUR时:无需填写该参数,默认为0;
  2. chargeMode=MONTH时:政企集团或省集团客户取值范围为[0,60],如果取值为0,会设置成订购一个月并开启自动续订,1-60表示具体订购的月数; 互联网客户取值范围为[1,60],1-60表示具体订购的月数;
  3. chargeMode=YEAR时:包年付费填写需要订购的年数,取值范围为[1,5]。
bootVolume
InstanceCreateBootVolume

系统盘。

size
integer(int32)

系统盘大小,单位为GB。Linux系统盘大小为max{20, 镜像大小},Windows系统盘最小为max{40, 镜像大小},最大均为1024。
默认值:
linux系统盘大小,max{20, 参数 ImageId 对应的镜像大小}。
windows系统盘大小,max{40, 参数 ImageId 对应的镜像大小}。

volumeType
string

系统盘类型。取值范围:

  • highPerformance:高性能型。
  • highPerformanceyc:高性能型-云创。
  • performanceOptimization:性能优化型。
  • performanceOptimizationyc:性能优化型-云创。

默认值:highPerformance。

displaySn
boolean

是否显示系统盘序列号,指定用户可设置,默认为空。取值范围:

  • true: 开启显示系统盘序列号。
  • false: 关闭显示系统盘序列号。
dataVolumes
<InstanceCreateDataVolume> array

数据盘。

size
integer(int32)

数据盘大小,单位为GB。

volumeType
string

数据盘类型。

kmsKeyId
string

KMS密钥ID。若填写该参数,则对数据盘进行加密。该参数和isShare不可同时填写。

isShare
boolean

是否为共享数据盘。取值范围:

  • true: 设置为共享数据盘。
  • false: 不设置共享数据盘。

默认值:false。

privateNetwork
InstanceCreatePrivateNetwork

实例私有网络信息。

privateIp
string

指定IP地址。

networkId
string

指定网络ID。

portId
string

指定网卡ID,填写该参数时quantity取值只能为1。

portType
integer(int32)

网卡类型。取值范围: - 0:普通云主机网卡。 - 1:云电脑网卡。云电脑网卡在调用关机释放资源后,网卡资源会进行释放。 默认值:0。

sourceDestCheck
boolean

是否开启源/目的地址检查。取值范围:

  • true:开启源/目的地址检查,会拦截源IP错误或不信任的数据包。
  • false:关闭源/目的地址检查,当服务器作网关、转发等功能时需关闭。

默认值:true。

publicNetwork
InstanceCreatePublicNetwork

实例公有网络信息。

ipType
string

公网IP类型。取值范围:

  • MOBILE:单线类型弹性公网IP。
  • MULTI_LINE:多线类型弹性公网IP。

默认值:MOBILE。

bandwidthSize
integer(int32)

公网IP带宽,单位:Mbps。取值范围为[0,500]。 默认值:0。

chargeMode
string

公网IP带宽计费方式。取值范围:

  • bandwidthCharge:按带宽计费。
  • trafficCharge:按流量计费。

默认值:bandwidthCharge。

ipv4Bandwidth
boolean

是否开通IPv4公网带宽。取值范围:

  • true:开通ipv4公网带宽。
  • false:不开通ipv4公网带宽。

默认值:true。

ipv6Bandwidth
boolean

是否开通IPv6公网带宽。取值范围:

  • true: 开通ipv6公网带宽。
  • false: 不开通ipv6公网带宽。

默认值:false。

eIpId
string

已订购的弹性公网IP ID,若填写该参数则不可新订购弹性公网IP,且quantity取值只能为1。

securityGroupIds
<string> array

安全组ID,如果指定网卡ID(即privateNetwork.portId)不为空),此参数无效。安全组id列表,可通过查询安全组列表获取,需选择裸金属类型安全组,安全组数量不能超过5个。

instanceName
string

实例名称。

extendedInstanceNameOption
ExtendedInstanceNameOption

创建实例名字自定义参数。

hostName
string

实例主机名,不指定主机名称时,随机生成。

userData
string

自定义参数,长度在[1,16384]个字符间。

description
string

实例描述。

tags
<Tag> array

标签列表。
说明:

  1. 一次绑定的标签不能超过10个;
  2. 标签的键值不能以ecloud开头;
  3. 标签可绑定实例和硬盘资源。
key
string

标签键,仅支持中英文、数字、中划线、下划线,长度1-127位之间。

value
string

标签值,仅支持数字、中英文、中划线、下划线,长度在1~255位之间,不能以ecloud开头。

stabilityPolicy
string

稳定性模式,指定客户可设置。取值范围:- BASE:虚拟机频率为当前CPU基频频率。

  • BALANCE:虚拟机频率设置为平衡模式。 默认值:BASE。
launchTemplateDescription
string

模板描述。

launchTemplateId
string

启动模板ID。

launchTemplateName
string

模板名称。

modifiedTime
string(date-time)

模板修改时间

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"requestId":"reqId-78bb47ec6f134c2f84202a345d509845",
	"state":"OK",
	"body":{
		"launchTemplateId":"0a5085097cbb4e30a473dd11c55d2d87",
		"createdTime":"2025-08-17 11:02:43",
		"modifiedTime":"2025-08-17 11:02:43",
		"launchTemplateName":"newtemplate129",
		"launchTemplateDescription":"template",
		"instanceTemplateData":{
			"zoneId":"cn-jiangsu-1a",
			"imageId":"89fb5e86-ea26-4bac-b078-213093b807c3",
			"flavorName":"c5e.2xlarge.2",
			"autoRenew":false,
			"groupId":null,
			"chargeMode":"YEAR",
			"duration":0,
			"quantity":1,
			"bootVolume":{
				"size":20,
				"volumeType":"highPerformance"
			},
			"dataVolumes":[
				{
					"size":20,
					"volumeType":"ssd",
					"kmsKeyId":null,
					"isShare":false
				}
			],
			"privateNetwork":{
				"privateIp":null,
				"networkId":"7b181e0a-c247-4871-bcf9-fc132844e309",
				"portId":null,
				"portType":0
			},
			"publicNetwork":null,
			"securityGroupIds":null,
			"instanceName":"ECS-12059256",
			"password":null,
			"keyPairName":null,
			"userData":null,
			"description":"apitttessssssst",
			"tags":[
				{
					"key":"k129",
					"value":"v129"
				}
			]
		}
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。