官方文档
首页 云服务器 ECS 开发参考 API参考（ECS） API目录 启动模板 DescribeLaunchTemplateVersions - 查询实例启动模板的版本信息

DescribeLaunchTemplateVersions - 查询实例启动模板的版本信息

更新时间：
复制 MD 格式
产品详情

查询ECS实例启动模板版本的信息，例如实例启动模板总数、模板名称、模板版本号等。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribeLaunchTemplateVersions

list

LaunchTemplate

acs:ecs:{#regionId}:{#accountId}:launchtemplate/*

LaunchTemplate

acs:ecs:{#regionId}:{#accountId}:launchtemplate/{#launchtemplateId}

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

实例启动模板所属的地域 ID。

您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
LaunchTemplateVersion

array

否

一个或多个实例启动模板版本号。

1

integer

否

一个或多个实例启动模板版本号。

1
LaunchTemplateId

string

否

实例启动模板 ID。

您必须指定LaunchTemplateId或LaunchTemplateName以确定模板。

lt-bp168lnahrdwl39p****
LaunchTemplateName

string

否

实例启动模板名称。

您必须指定LaunchTemplateId或LaunchTemplateName以确定模板。

testLaunchTemplateName
MinVersion

integer

否

限定查询的最小版本号。与MaxVersion结合使用，可查询最小版本号和最大版本号区间的版本信息。

1
MaxVersion

integer

否

限定查询的最大版本号。与MinVersion结合使用，可查询最小版本号和最大版本号区间的版本信息。

10
DefaultVersion

boolean

否

是否查询默认版本。

true
DetailFlag

boolean

否

是否查询模板配置详细信息。取值范围：

  • true：查询模版配置详细信息，在模版基本信息的基础上，还会返回模版配置细节，如镜像 ID、系统盘大小等。

  • false：只查询模版基本信息，如模版 ID、模版名称、默认版本等。

默认值：true。

true
PageNumber

integer

否

实例启动模板列表的页码。

起始值：1。

默认值：1。

1
PageSize

integer

否

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

默认值：10。

10

返回参数

名称

类型

描述

示例值

object

版本信息集合。

PageSize

integer

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

10
RequestId

string

请求 ID。

3989ED0C-20A1-4351-A127-2067FF8390AX
PageNumber

integer

当前页码。

1
TotalCount

integer

实例启动模板总数。？？？？？？？？？？

1
LaunchTemplateVersionSets

object

LaunchTemplateVersionSet

array<object>

模板版本的信息。

array<object>

模板版本的信息。

LaunchTemplateName

string

模板名称。

testLaunchTemplateName
DefaultVersion

boolean

模板是否为默认版本。

true
VersionNumber

integer

模板版本号。

1
ModifiedTime

string

模板修改时间。

2022-01-17T08:40:00Z
LaunchTemplateId

string

模板 ID。

lt-bp67acfmxazb4p****
CreateTime

string

模板创建时间。

2022-01-17T08:22:43Z
CreatedBy

string

模板的创建者，即阿里云账号 ID。

123456789****
VersionDescription

string

模板版本描述。

testVersionDescription
LaunchTemplateData

object

模板具体配置。

DeploymentSetId

string

部署集 ID。

ds-bp1brhwhoqinyjd6****
VpcId

string

专有网络 VPC ID。

v-bp67acfmxazb4p****
SystemDisk.PerformanceLevel

string

创建 ESSD 云盘作为系统盘使用时，设置云盘的性能等级。可能值：

  • PL0（默认）：单盘最高随机读写 IOPS 1 万。

  • PL1：单盘最高随机读写 IOPS 5 万。

  • PL2：单盘最高随机读写 IOPS 10 万。

  • PL3：单盘最高随机读写 IOPS 100 万。

有关如何选择 ESSD 性能等级，请参见 ESSD 云盘。

PL0
KeyPairName

string

密钥对名称。

testKeyPairName
SecurityGroupId

string

实例的安全组 ID。

说明

SecurityGroupId和SecurityGroupIds不会同时返回值。

sg-bp67acfmxazb4p****
NetworkType

string

网络类型。可能值：

  • vpc：专有网络 VPC。

  • classic：经典网络。经典网络功能已下线，详情请参见下线公告。

vpc
SpotStrategy

string

按量付费实例的竞价策略。可能值：

  • NoSpot：正常按量付费实例。

  • SpotWithPriceLimit：设置上限价格的抢占式实例。

  • SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。

NoSpot
EnableVmOsConfig

boolean

是否启用实例操作系统配置。

false
Description

string

实例描述。

testInstanceDescription
SpotDuration

integer

抢占式实例的保留时长，单位为小时。 可能值：

  • 1：创建后阿里云会保证实例运行 1 小时不会被自动释放；超过 1 小时后，系统会自动比较出价与市场价格、检查资源库存，来决定实例的持有和回收。

  • 0：创建后，阿里云不保证实例运行 1 小时，系统会自动比较出价与市场价格、检查资源库存，来决定实例的持有和回收。

实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费，建议您结合具体任务执行耗时来选择合适的保留时长。

说明

当 SpotStrategy 值为 SpotWithPriceLimit 或 SpotAsPriceGo 时返回该参数。

1
InstanceName

string

实例名称。

testInstanceName
SecurityEnhancementStrategy

string

是否开启安全加固。

active
UserData

string

实例自定义数据，以 Base64 方式编码。

SGVsbG9FQ1M=
SystemDisk.DiskName

string

系统盘名称。

testSystemDiskName
SystemDisk.Size

integer

系统盘大小，单位：GiB。

40
SpotPriceLimit

number

设置实例的每小时最高价格。

0.98
PasswordInherit

boolean

是否继承原镜像里设置的用户名密码。

true
PrivateIpAddress

string

实例私网 IP 地址。

10.1.**.**
ImageId

string

实例使用的镜像 ID。

m-bp67acfmxazb4p****
SystemDisk.DeleteWithInstance

boolean

系统盘是否随实例释放。可能值：

  • true：随实例释放。

  • false：不随实例释放。

true
SystemDisk.Category

string

系统盘的云盘种类。可能值：

  • cloud：普通云盘。

  • cloud_efficiency：高效云盘。

  • cloud_ssd：SSD 云盘。

  • cloud_essd：ESSD 云盘。您可以通过参数 SystemDisk.PerformanceLevel 设置云盘的性能等级。

已停售的实例规格且非 I/O 优化实例默认值为 cloud，否则默认值为 cloud_efficiency。

cloud_ssd
AutoReleaseTime

string

自动释放时间。

2018-05-14T14:18:00Z
SystemDisk.Description

string

系统盘描述。

testSystemDiskDescription
ImageOwnerAlias

string

镜像来源。可能值：

  • system：阿里云提供的公共镜像。

  • self：您创建的自定义镜像。

  • others：其他阿里云用户共享给您的镜像。

  • marketplace：云市场镜像。

system
HostName

string

实例主机名。

testHostName
SystemDisk.Iops

integer

系统盘总 IOPS。

101800
SystemDisk.AutoSnapshotPolicyId

string

自动快照策略 ID。

sp-bp1j0alc2z1fhvie****
InternetMaxBandwidthOut

integer

公网出带宽最大值。

100
InternetMaxBandwidthIn

integer

公网入带宽最大值。

5
InstanceType

string

实例规格。

ecs.g5.large
Period

integer

购买资源的时长。

1
InstanceChargeType

string

实例计费类型。可能值：

  • PrePaid：包年包月。

  • PostPaid：按量付费。

Postpaid
IoOptimized

string

是否为 I/O 优化实例。

none
RamRoleName

string

实例 RAM 角色名称。

testRamRoleName
VSwitchId

string

实例所属的虚拟交换机 ID。

vsw-bp67acfmxazb4p****
ResourceGroupId

string

启动模板所在的企业资源组 ID。

rg-bp67acfmxazb4p****
InternetChargeType

string

公网带宽计费方式。

PayByTraffic
ZoneId

string

可用区 ID。

cn-hangzhou-g
Ipv6AddressCount

integer

实例的 IPv6 地址数量。

1
DataDisks

object

DataDisk

array<object>

数据盘集合。

object

数据盘集合。

PerformanceLevel

string

创建 ESSD 云盘作为数据盘使用时，设置云盘的性能等级。当Category=cloud_essd时该参数有返回值。可能值：

  • PL0：单盘最高随机读写 IOPS 1 万。

  • PL1：单盘最高随机读写 IOPS 5 万。

  • PL2：单盘最高随机读写 IOPS 10 万。

  • PL3：单盘最高随机读写 IOPS 100 万。

PL1
Description

string

数据盘描述。

testDiskDescription
SnapshotId

string

数据盘使用的快照 ID。

s-bp67acfmxazb4p****
Device

string

数据盘的挂载点。挂载的数据盘数量不同，挂载点的命名不同：

  • 1~25 块数据盘：/dev/xvd[b-z]

  • 大于 25 块数据盘：/dev/xvd[aa-zz]，例如第 26 块数据盘会被命名为/dev/xvdaa，第 27 块数据盘为/dev/xvdab，以此类推。

说明

该参数仅用于全镜像（整机镜像）场景。您可以通过将此参数设置为全镜像中数据盘对应的挂载点，并修改对应的DataDisk.N.Size和DataDisk.N.Category参数，达到修改全镜像中数据盘磁盘种类和大小的目的。

/dev/xvdb

Size

integer

数据盘大小。

2000
DiskName

string

数据盘名称。

testDiskName
Category

string

数据盘 N 的云盘种类。取值范围：

  • cloud_efficiency：高效云盘。

  • cloud_ssd：SSD 云盘。

  • cloud_essd：ESSD 云盘。

  • cloud：普通云盘。

  • cloud_auto：ESSD AutoPL 云盘。

  • cloud_regional_disk_auto：ESSD 同城冗余云盘。

  • cloud_essd_entry：ESSD Entry 云盘。
    说明

    仅当InstanceType设置为ecs.u1或ecs.e规格族时，该参数支持cloud_essd_entry。

  • elastic_ephemeral_disk_standard：弹性临时盘-标准版。

  • elastic_ephemeral_disk_premium：弹性临时盘-高级版。

对于 I/O 优化实例，默认值为 cloud_efficiency。对于非 I/O 优化实例，默认值为 cloud。 参数默认值说明：

  • 当 InstanceType 为已停售且非 I/O 优化的实例规格，该参数默认值为cloud。

  • 其它情况下，该参数默认值为cloud_efficiency。

cloud_ssd
DeleteWithInstance

boolean

数据盘是否随实例释放而释放。

true
Encrypted

string

数据盘是否加密。

false
ProvisionedIops

integer

是否修改 ESSD AutoPL 云盘预配置读写 IOPS。取值范围：0~min{50000, 1000*容量-基准性能}。

基准性能=min{1,800+50*容量, 50,000}

说明

当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息，请参见ESSD AutoPL 云盘和修改 ESSD AutoPL 云盘预配置信息。

50000
BurstingEnabled

boolean

是否开启 Burst（性能突发）。取值范围：

  • true：是。

  • false：否。

true
AutoSnapshotPolicyId

string

自动快照策略 ID。

sp-wz91dz3ghear2a5s****
KMSKeyId

string

数据盘对应的 KMS 密钥 ID。

0e478b7a-4262-4802-b8cb-00d3fb40****
NetworkInterfaces

object

NetworkInterface

array<object>

辅助弹性网卡的属性集合。

array<object>

辅助弹性网卡的属性集合。

NetworkInterfaceName

string

辅助弹性网卡名称。

testNetworkInterfaceName
VSwitchId

string

弹性网卡所属的虚拟交换机 ID。

vsw-bp67acfmxazb4p****
Description

string

辅助弹性网卡描述信息。

testNetworkInterfacesDescription
PrimaryIpAddress

string

辅助弹性网卡的主私有 IP 地址。

203.0.*.*
SecurityGroupId

string

辅助弹性网卡所属的安全组 ID。必须是同一个 VPC 下的安全组。

说明

SecurityGroupId 和 SecurityGroupIds 不会同时返回值。

sg-bp67acfmxazb4p****
SecurityGroupIds

object

SecurityGroupId

array

辅助弹性网卡加入的一个或多个安全组。

说明

SecurityGroupId 和 SecurityGroupIds 不会同时返回值。

string

辅助弹性网卡加入的一个或多个安全组。

说明

SecurityGroupId 和 SecurityGroupIds 不会同时返回值。

["sg-bp15ed6xe1yxeycg7****"]
InstanceType

string

实例的规格。

ecs.s2.xlarge
NetworkInterfaceTrafficMode

string

主网卡的通讯模式。参数取值范围：

  • Standard：使用 TCP 通讯模式。

  • HighPerformance：开启 ERI（Elastic RDMA Interface）接口，使用 RDMA 通讯模式。

Standard
DeleteOnRelease

boolean

释放实例时是否保留网卡。可能值：

  • true：不保留。

  • false：保留。

true
Tags

object

InstanceTag

array<object>

实例的标签列表。

object

实例的标签列表。

Key

string

实例的标签键。

TestKey
Value

string

实例的标签值。

TestValue
SecurityGroupIds

object

SecurityGroupId

array

实例加入的一个或多个安全组。

说明

SecurityGroupId和SecurityGroupIds不会同时返回值。

string

实例加入的一个或多个安全组。

说明

SecurityGroupId和SecurityGroupIds不会同时返回值。

["sg-bp15ed6xe1yxeycg7****"]
SystemDisk.ProvisionedIops

integer

ESSD AutoPL 云盘预配置读写 IOPS。取值范围：0~min{50000, 1000*容量-基准性能}。

基准性能=min{1,800+50*容量, 50,000}

说明

当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息，请参见ESSD AutoPL 云盘和修改 ESSD AutoPL 云盘预配置信息。

50000
SystemDisk.BurstingEnabled

boolean

是否开启 Burst（性能突发）。取值范围：

  • true：是。

  • false：否。

true
SystemDisk.Encrypted

string

系统盘是否加密。可能值：

  • true：加密。

  • false：不加密。

默认值：false。

说明

中国香港 D 可用区、新加坡 A 可用区暂不支持在创建实例时加密系统盘。

false
DeletionProtection

boolean

实例释放保护属性，指定是否支持通过控制台或 API（ DeleteInstance ）释放实例。取值范围：

  • true：开启实例释放保护。

  • false：关闭实例释放保护。

默认值：false。

说明

该属性仅适用于按量付费实例，且只能限制手动释放操作，对系统释放操作不生效。

false
CreditSpecification

string

突发性能实例的运行模式。可能值：

Standard
AutoRenew

boolean

是否要自动续费。当参数InstanceChargeType取值PrePaid时才生效。可能值：

  • true：自动续费。

  • false：不自动续费。

默认值：false。

true
AutoRenewPeriod

integer

单次自动续费的续费时长。可能值：

PeriodUnit=Month 时：1、2、3、6、12、24、36、48、60。

默认值：1。

1
PeriodUnit

string

包年包月计费方式的时长单位。可能值：

Month（默认）。

Month
HttpEndpoint

string

是否启用实例元数据的访问通道。可能值：

  • enabled：启用。

  • disabled：禁用。

默认值：enabled。

说明

有关实例元数据的信息，请参见实例元数据概述。

enabled
HttpTokens

string

访问实例元数据时是否强制使用加固模式（IMDSv2）。可能值：

  • optional：不强制使用。

  • required：强制使用。设置该取值后，普通模式无法访问实例元数据。

默认值：optional。

说明

有关访问实例元数据的模式，请参见实例元数据概述。

optional
HttpPutResponseHopLimit

integer
说明

该参数暂未开放使用。

3
SystemDisk.KMSKeyId

string

系统盘对应的 KMS 密钥 ID。

0e478b7a-4262-4802-b8cb-00d3fb40****

ImageOptions

object

镜像相关属性信息。

LoginAsNonRoot

boolean

使用该镜像的实例是否支持使用 ecs-user 用户登录。 可能值：

  • true：是。

  • false：否。

false
SecurityOptions

object

安全选项。

TrustedSystemMode

string

可信系统模式。取值：vTPM。

目前，可信系统模式支持的实例规格族：

  • g7、c7、r7。

  • 安全增强型（g7t、c7t、r7t）。

当您创建以上实例规格族的 ECS 实例时，需要设置该参数。具体说明如下：

  • 如果您使用阿里云可信系统，请将该参数值设置为 vTPM，在实例启动时即可通过阿里云可信系统完成可信校验。

  • 如果您不使用阿里云可信系统，可以不设置该参数值，但您需要注意，如果您所创建的 ECS 实例使用了 Enclave 机密计算模式（SecurityOptions.ConfidentialComputingMode=Enclave），则该 ECS 实例也会启用可信系统。

  • 通过 OpenAPI 创建可信系统的 ECS 实例时，只能调用RunInstances实现，CreateInstance目前不支持设置SecurityOptions.TrustedSystemMode参数。

说明

如果您在创建实例的时候指定其为可信实例，那么当您更换系统盘时只能使用支持可信系统的镜像。

关于可信系统的更多信息，请参见安全增强型实例可信功能概述。

vTPM

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "3989ED0C-20A1-4351-A127-2067FF8390AX",
  "PageNumber": 1,
  "TotalCount": 1,
  "LaunchTemplateVersionSets": {
    "LaunchTemplateVersionSet": [
      {
        "LaunchTemplateName": "testLaunchTemplateName",
        "DefaultVersion": true,
        "VersionNumber": 1,
        "ModifiedTime": "2022-01-17T08:40:00Z",
        "LaunchTemplateId": "lt-bp67acfmxazb4p****",
        "CreateTime": "2022-01-17T08:22:43Z",
        "CreatedBy": "123456789****",
        "VersionDescription": "testVersionDescription",
        "LaunchTemplateData": {
          "DeploymentSetId": "ds-bp1brhwhoqinyjd6****",
          "VpcId": "v-bp67acfmxazb4p****",
          "SystemDisk.PerformanceLevel": "PL0",
          "KeyPairName": "testKeyPairName",
          "SecurityGroupId": "sg-bp67acfmxazb4p****",
          "NetworkType": "vpc",
          "SpotStrategy": "NoSpot",
          "EnableVmOsConfig": false,
          "Description": "testInstanceDescription",
          "SpotDuration": 1,
          "InstanceName": "testInstanceName",
          "SecurityEnhancementStrategy": "active",
          "UserData": "SGVsbG9FQ1M=",
          "SystemDisk.DiskName": "testSystemDiskName",
          "SystemDisk.Size": 40,
          "SpotPriceLimit": 0.98,
          "PasswordInherit": true,
          "PrivateIpAddress": "10.1.**.**",
          "ImageId": "m-bp67acfmxazb4p****",
          "SystemDisk.DeleteWithInstance": true,
          "SystemDisk.Category": "cloud_ssd",
          "AutoReleaseTime": "2018-05-14T14:18:00Z",
          "SystemDisk.Description": "testSystemDiskDescription",
          "ImageOwnerAlias": "system",
          "HostName": "testHostName",
          "SystemDisk.Iops": 101800,
          "SystemDisk.AutoSnapshotPolicyId": "sp-bp1j0alc2z1fhvie****",
          "InternetMaxBandwidthOut": 100,
          "InternetMaxBandwidthIn": 5,
          "InstanceType": "ecs.g5.large",
          "Period": 1,
          "InstanceChargeType": "Postpaid",
          "IoOptimized": "none",
          "RamRoleName": "testRamRoleName",
          "VSwitchId": "vsw-bp67acfmxazb4p****",
          "ResourceGroupId": "rg-bp67acfmxazb4p****",
          "InternetChargeType": "PayByTraffic",
          "ZoneId": "cn-hangzhou-g",
          "Ipv6AddressCount": 1,
          "DataDisks": {
            "DataDisk": [
              {
                "PerformanceLevel": "PL1",
                "Description": "testDiskDescription",
                "SnapshotId": "s-bp67acfmxazb4p****",
                "Device": "/dev/xvdb\n",
                "Size": 2000,
                "DiskName": "testDiskName",
                "Category": "cloud_ssd",
                "DeleteWithInstance": true,
                "Encrypted": "false",
                "ProvisionedIops": 50000,
                "BurstingEnabled": true,
                "AutoSnapshotPolicyId": "sp-wz91dz3ghear2a5s****",
                "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
              }
            ]
          },
          "NetworkInterfaces": {
            "NetworkInterface": [
              {
                "NetworkInterfaceName": "testNetworkInterfaceName",
                "VSwitchId": "vsw-bp67acfmxazb4p****",
                "Description": "testNetworkInterfacesDescription",
                "PrimaryIpAddress": "203.0.*.*",
                "SecurityGroupId": "sg-bp67acfmxazb4p****",
                "SecurityGroupIds": {
                  "SecurityGroupId": [
                    "[\"sg-bp15ed6xe1yxeycg7****\"]"
                  ]
                },
                "InstanceType": "ecs.s2.xlarge",
                "NetworkInterfaceTrafficMode": "Standard",
                "DeleteOnRelease": true
              }
            ]
          },
          "Tags": {
            "InstanceTag": [
              {
                "Key": "TestKey",
                "Value": "TestValue"
              }
            ]
          },
          "SecurityGroupIds": {
            "SecurityGroupId": [
              "[\"sg-bp15ed6xe1yxeycg7****\"]"
            ]
          },
          "SystemDisk.ProvisionedIops": 50000,
          "SystemDisk.BurstingEnabled": true,
          "SystemDisk.Encrypted": "false",
          "DeletionProtection": false,
          "CreditSpecification": "Standard",
          "AutoRenew": true,
          "AutoRenewPeriod": 1,
          "PeriodUnit": "Month",
          "HttpEndpoint": "enabled",
          "HttpTokens": "optional",
          "HttpPutResponseHopLimit": 3,
          "SystemDisk.KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****\n",
          "ImageOptions": {
            "LoginAsNonRoot": false
          },
          "SecurityOptions": {
            "TrustedSystemMode": "vTPM"
          }
        }
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidRegion.NotExist %s 指定的地域不存在，请确认参数是否正确。
400 MissingParameter %s 缺失参数，请检查参数是否完整。
400 InvalidParameter %s 无效的参数。
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误，请重试。
403 InnerServiceFailed %s 内部服务调用失败。
404 InvalidLaunchTemplate.NotFound The specified LaunchTemplate is not found. 指定的模板未找到。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：CreateLaunchTemplateVersion - 在实例启动模板中创建新版本下一篇：ModifyLaunchTemplateDefaultVersion - 切换启动模板的默认版本