You need to enable JavaScript to run this app.
导航
DescribeLaunchTemplateVersions - 查询实例启动模板版本
最近更新时间:2024.08.15 14:19:16首次发布时间:2024.08.15 14:19:16

调用 DescribeLaunchTemplateVersions 接口,查询实例启动模板版本。

请求参数

名字类型是否必填示例值描述
ActionStringDescribeLaunchTemplateVersions要执行的操作,取值:DescribeLaunchTemplateVersions。
VersionString2020-04-01API的版本,取值:2020-04-01。

LaunchTemplateId

String

LaunchTemplateId=lt-3ti78x9h8t4bw****

实例启动模板的ID。
您必须指定LaunchTemplateIdLaunchTemplateName以确定模板。

LaunchTemplateName

String

LaunchTemplateNames=test

实例启动模板的名称。
您必须指定LaunchTemplateIdLaunchTemplateName以确定模板。

LaunchTemplateVersions.N

Integer

1

实例启动模板版本,最多支持30个。

  • 参数 - N:表示实例启动模板的序号。

  • 多个版本之间用&分隔。

DefaultVersion

Boolean

true

是否查询默认版本,取值:

  • true(默认):查询默认版本。

  • false:不查询默认版本。

NextToken

String

-

分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。

MaxResults

Integer

10

分页查询时设置的每页行数:

  • 最大值:100

  • 默认值:10

返回数据

名称类型示例值描述

NextToken

String

-

本次调用返回的查询凭证值,返回为空表示该页为末页。

LaunchTemplateVersions

Array of Struct

-

符合条件的实例启动模板信息,具体请参见下表“LaunchTemplateVersions 结构”。

LaunchTemplateVersions 结构

名称类型示例值描述
LaunchTemplateIdStringlt-ysxc16auaugh9zfy****实例启动模板ID。
VersionNumberString1模板版本号。
VersionDescriptionStringtestVersionDescription模板版本描述。
LaunchTemplateVersionDataObject-模板配置信息,具体请参见下表“LaunchTemplateVersionData 结构”。
CreatedAtString2022-06-09 10:38:20实例启动模板的创建时间。
UpdatedAtString2022-06-09 10:38:20实例启动模板的更新时间。

LaunchTemplateVersionData 结构

名称类型示例值描述
ImageIdStringimage-ybmhzqo8u4l8j1ii****镜像ID。

SecurityEnhancementStrategy

String

Active

是否开启安全加固,取值:

  • Active:开启安全加固,仅对公共镜像生效。

  • InActive:关闭安全加固,对所有镜像生效。

InstanceTypeIdStringecs.g3i.large实例的规格。
KeyPairNameStringkp-test-123实例绑定的密钥对。
InstanceNameStringinstance-1实例名称。
DescriptionString用于测试的云服务器实例实例描述。
HostNameStringinstance-host-name实例主机名。
UserDataStringIyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******实例的自定义数据。
ZoneIdStringcn-beijing-a实例所属可用区ID。
VolumesArray of Struct-实例绑定云盘信息,具体请参见下表“ Volumes 结构”。
EipArray of Struct-实例绑定的公网IP信息,具体请参见下表“ Eip 结构”。
VpcIdStringvpc-3thbinq64t4bwbha****私有网络ID。
HpcClusterIdStringhpcCluster-l8u24ovdmoab6opf****高性能计算集群ID。

InstanceChargeType

String

PostPaid

实例和云盘的计费类型。取值:

  • PostPaid:按量付费。

  • PrePaid:包年包月。

UniqueSuffix

Boolean

false

是否开启有序后缀,取值:

  • true:开启有序后缀。

  • false:关闭有序后缀。

SuffixIndexInteger0有序后缀的起始序号。
ProjectNameStirngdefault实例所属项目。

SpotStrategy

String

NoSpot

按量计费的抢占式策略。,取值:

  • NoSpot:表示创建正常按量计费实例。

  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格的抢占式实例。

  • SpotWithPriceLimit:设置出价上限的抢占式实例。

SpotPriceLimitFloat320.78抢占式实例的每小时最高价格。
NetworkInterfacesArray of Struct-实例挂载的网卡信息。具体请参见下表“NetworkInterfaces 结构”。
ScheduledInstanceStruct弹性预约单信息,具体请参见下表“ ScheduledInstance 结构
TagsArray of Struct-资源的标签信息,具体请参见下表“ Tags 结构”。
Volume 结构
名称类型示例值描述

VolumeType

String

ESSD_PL0

云盘的类型,取值:

  • ESSD_PL0:极速型SSD PL0。

  • PTSSD:性能型SSD。

Size

Integer

100

云盘的容量,单位为GiB。

DeleteWithInstance

Boolean

true

云盘是否随实例释放,取值:

  • true:云盘随实例释放。

  • false:云盘不随实例释放。

Eip 结构
名称类型示例值描述

BillingType

Integer

2

公网IP的计费方式,取值:

  • 2:按量计费-按带宽上限计费。

  • 3:按量计费-按实际流量计费。

Bandwidth

Integer

1

公网IP的带宽上限,单位:Mbps。

  • 取值范围:1~200。

  • 默认值:1。

ISP

String

BGP

公网IP的线路类型,取值:

  • BGP:BGP(多线)。

  • ChinaMobile:中国移动静态单线。

  • ChinaTelecom:中国电信静态单线。

  • ChinaUnicom:中国联通静态单线。

BandwidthPackageId

String

bwp-2zeo05qre24nhrqpy****

共享带宽包的ID。

SecurityProtectionTypes

List

[AntiDDoS_Enhanced]

公网IP的安全防护类型。取值:

  • AntiDDoS_Enhanced:申请增强防护类型的公网IP,可加入到DDoS原生防护(企业版)实例。
SecurityProtectionInstanceIdInteger200安全防护包ID。
NetworkInterfaces 结构
名称类型示例值描述
SubnetIdStringsubnet-3tisodmzai4e8i4q****子网ID。
SecurityGroupIdsList["sg-3ti78x9h8t4bwbhb****", "sg-mj8jry2d3vnk5smt1a2ae****"]安全组ID。
ScheduledInstance 结构
名称类型示例值描述
ScheduledInstanceNameStringESI-Name弹性预约单的名称。
ScheduledInstanceDescriptionString用于测试的弹性预约单弹性预约单的描述。
Tags 结构
名称类型示例值描述
KeyStringk1实例的标签键。
ValueStringv1实例的标签值。

请求示例

GET /?Action=DescribeLaunchTemplateVersions&Version=2020-04-01&LaunchTemplateId=lt-ysxc16auaugh9zfy**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220419160338010225133143077B****",
        "Action": "DescribeLaunchTemplateVersions",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "LaunchTemplateVersions": [
            {
                "LaunchTemplateId": "lt-ysxc16auaugh9zfy****",
                "VersionNumber": 1,
                "VersionDescription": "testVersionDescription",
                "LaunchTemplateVersionData": {
                    "ZoneId": "cn-beijing-a",
                    "InstanceTypeId": "ecs.g3i.large",
                    "ImageId": "image-ybmhzqo8u4l8j1ii****",
                    "InstanceChargeType": "PostPaid",
                    "InstanceName": "instance-1",
                    "Description": "用于测试的云服务器实例",
                    "HostName": "instance-host-name",
                    "UniqueSuffix": false,
                    "SuffixIndex": 0,
                    "KeyPairName": "kp-test-123",
                    "SecurityEnhancementStrategy": "Active",
                    "UserData": "IyEvYmluL2Jhc2gKdG91Y2ggL3RtcC91c2VyZG******",
                    "HpcClusterId": "hpcCluster-l8u24ovdmoab6opf****",
                    "Volumes": [],
                    "NetworkInterfaces": [
                        {
                            "SubnetId": "subnet-3tisodmzai4e8i4q****",
                            "SecurityGroupIds": [
                                "sg-3ti78x9h8t4bwbhb****"
                            ],
                        },
                    ],
                    "Eip": {
                        "Bandwidth": 1,
                        "ISP": "BGP",
                        "BillingType": 2
                    },
                    "VpcId": "vpc-3thbinq64t4bwbha****"
                },
                "CreatedAt": "2022-06-09 10:38:20",
                "UpdatedAt": "2022-06-09 10:38:20"
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.AccountIdThe required parameter AccountId is not supplied.账户ID不能为空。
400QuotaExceeded.TemplateVersionQuotaYou've reached the limit on the Quota.该实例启动模板下版本数量超限额。
400MissingParameter.LaunchTemplateNameAndLaunchTemplateIdThe required parameter LaunchTemplateName and LaunchTemplateId is not supplied.模版名称和模版ID不允许同时为空。
404InvalidLaunchTemplate.NotFoundThe specified LaunchTemplate does not exist.指定的启动模板不存在。
500InternalErrorAn internal error has occurred.内部错误,请重试。如果多次尝试失败,请提交工单。