接口说明
更新实例启动模板。
注意事项:
-
启动模板不支持存储密码、密钥对、自动退订配置。
-
弹性裸金属计算型与本地存储型规格目前仅支持挂载高性能型系统盘和数据盘,弹性裸金属暂不支持按量计费。
-
若您设置的系统盘
size小于镜像要求的最小值,将自动更新为当前镜像所允许的最小值。例如:某linux镜像要求最小值为30,您设置的系统盘size为20,最终实例模板创建成功后size为30。 -
若参数
publicNetwork.bandwidthSize的值大于0,则使用当前模板创建实例后会创建弹性公网IP,并产生计费。 -
如果实例启动模板中设置了某一配置,批量创建实例时就无法过滤掉该配置。例如,如果模板设置了
instanceName=instanceTestName,创建实例中instanceName取值为空时,实例的主机名依然是instanceTestName。如果您想覆盖instanceName=instanceTestName这一配置,可以在创建实例中取instanceName=instanceTestNameV1或其他参数值。
使用建议:
1.可以使用dryRun = true来进行参数预检。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/launch-template/update
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceTemplateUpdateReq
|
InstanceTemplateUpdateInfo
|
是
|
instanceTemplateUpdateReq |
|
launchTemplateId
|
string
|
是
|
启动模板 ID。您可以通过查询启动模板列表获取信息。 |
|
zoneId
|
string
|
否
|
可用区,可通过查询属地地域可用区信息接口获取。 |
|
launchTemplateName
|
string
|
否
|
模板名称。长度为2 - 64个字符,以大小写字母开头,可包含数字、点号(.)、下划线(_)或连字符(~)。 |
|
launchTemplateDescription
|
string
|
否
|
模板描述。长度不超过128个字符。 |
|
imageId
|
string
|
否
|
镜像ID,您可以通过下面的接口查询您需要的镜像。 |
|
flavorName
|
string
|
否
|
规格名称。可通过查询实例可用规格列表获取。 |
|
groupId
|
string
|
否
|
实例群组ID。您可以通过查询实例群组列表接口获取。 |
|
chargeMode
|
string
|
否
|
付费方式。取值范围:
默认值:HOUR。 |
|
duration
|
integer(int32)
|
否
|
订购时长(月/年),单位由
|
|
bootVolume
|
InstanceCreateBootVolume
|
否
|
系统盘。 |
|
size
|
integer(int32)
|
否
|
系统盘大小,单位为GB。Linux系统盘大小为max{20, 镜像大小},Windows系统盘最小为max{40, 镜像大小},最大均为1024。 |
|
volumeType
|
string
|
否
|
系统盘类型,你可以通过查询可用区系统盘类型接口查看当前资源池可用区可用系统盘类型。取值范围:
|
|
displaySn
|
boolean
|
否
|
是否显示系统盘序列号,指定用户可设置,默认为空。取值范围:
|
|
dataVolumes
|
<InstanceCreateDataVolume> array
|
否
|
数据盘信息集合列表。数据盘数量最高59块,具体数量以帮助中心规格为准。 |
|
size
|
integer(int32)
|
否
|
数据盘大小,单位为GB。取值范围为[10,32768]。 |
|
volumeType
|
string
|
否
|
数据盘类型。取值范围:
默认值:capebs。 |
|
kmsKeyId
|
string
|
否
|
KMS密钥ID。若填写该参数,则对数据盘进行加密。该参数和isShare不可同时填写。 |
|
isShare
|
boolean
|
否
|
是否为共享数据盘。取值范围:
默认值:false。 |
|
privateNetwork
|
InstanceCreatePrivateNetwork
|
否
|
实例私有网络信息。 |
|
privateIp
|
string
|
否
|
指定IP地址。 |
|
networkId
|
string
|
否
|
指定与待创建实例同一可用区下的网络ID,您可以通过查询VPC下网络反参中的ID来获取该参数。 |
|
portId
|
string
|
否
|
指定网卡ID,您可以通过查询虚拟网卡列表获取。 |
|
portType
|
integer(int32)
|
否
|
网卡类型。取值范围:
默认值:0。 |
|
sourceDestCheck
|
boolean
|
否
|
是否开启源/目的地址检查。取值范围:
默认值:true。 注意:可通过虚拟私有云-可用区域中可用区类型确认当前可用区是否支持,其中B类可用区不支持,该参数不生效。 |
|
publicNetwork
|
InstanceCreatePublicNetwork
|
否
|
实例公有网络信息。 |
|
ipType
|
string
|
否
|
公网IP类型。取值范围:
默认值:MOBILE。 |
|
bandwidthSize
|
integer(int32)
|
否
|
公网IP带宽,单位:Mbps。取值范围为[0,500]。 默认值:0。 |
|
chargeMode
|
string
|
否
|
公网IP带宽计费方式。取值范围:
默认值:bandwidthCharge。 |
|
ipv4Bandwidth
|
boolean
|
否
|
是否开通IPv4公网带宽。取值范围:
默认值:true。 |
|
ipv6Bandwidth
|
boolean
|
否
|
是否开通IPv6公网带宽。取值范围:
默认值:false。 |
|
eIpId
|
string
|
否
|
已订购的弹性公网IP ID,若填写该参数则不可新订购弹性公网IP。 |
|
securityGroupIds
|
<string> array
|
否
|
安全组ID数组。您可以通过查询安全组列表获取安全组ID。如果指定网卡ID(即privateNetwork.portId)不为空,此参数无效。安全组数量不能超过5个。 |
|
instanceName
|
string
|
否
|
实例名称。名称为5~59个字符,可包含英文、中文、数字,'-','-'不可在名称开头或末尾;
|
|
extendedInstanceNameOption
|
ExtendedInstanceNameOption
|
否
|
创建实例名字自定义参数。 |
|
hostName
|
string
|
否
|
实例主机名称,不指定主机名称时,随机生成。名称为5~59个字符,可包含英文、数字,'-','-'不可在名称开头或末尾;
|
|
userData
|
string
|
否
|
自定义参数,长度在[1,16384]个字符间。 |
|
description
|
string
|
否
|
实例描述。 |
|
tags
|
<Tag> array
|
否
|
标签列表。
|
|
key
|
string
|
是
|
标签键,仅支持中英文、数字、中划线、下划线,长度1-127位之间,不能以 |
|
value
|
string
|
是
|
标签值,仅支持数字、中英文、中划线、下划线,长度在1~255位之间,不能以 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/launch-template/update
{
"launchTemplateId":"574cdc2d-f96a-4540-1ad1-2e31231d6042",
"launchTemplateDescription":"这是一个模板",
"launchTemplateName":"templateCreateVm",
"zoneId":"cn-jiangsu-1a",
"chargeMode":"MONTH",
"duration":0,
"flavorName":"c5.large.2",
"imageId":"574cdc2d-f96a-4540-bbd1-2e38ca1d6042",
"bootVolume":{
"size":0,
"volumeType":"highPerformance"
},
"dataVolumes":[
{
"isShare":false,
"size":0,
"volumeType":"capebs"
}
],
"privateNetwork":{
"networkId":"574cdc2d-f96a-4540-1ad1-2e38ca1d6042"
},
"instanceName":"testVm"
}
返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
boolean
|
请求成功时返回的数据。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。 |
返回示例
{
"requestId":"reqId-49b078faacbc1dc85d66c-a156faae-6",
"state":"OK",
"body":true
}