全部产品
Search
文档中心

云服务器 ECS:DescribeLaunchTemplateVersions - 查询ECS实例启动模板版本

更新时间:May 31, 2024

调用DescribeLaunchTemplateVersions查询ECS实例启动模板版本。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeLaunchTemplateVersionsRead
  • LaunchTemplate
    acs:ecs:{#regionId}:{#accountId}:launchtemplate/*
  • LaunchTemplate
    acs:ecs:{#regionId}:{#accountId}:launchtemplate/{#launchtemplateId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-hangzhou
LaunchTemplateVersionarray

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

long

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

1
LaunchTemplateIdstring

实例启动模板 ID。

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

lt-bp168lnahrdwl39p****
LaunchTemplateNamestring

实例启动模板名称。

testLaunchTemplateName
MinVersionlong

通过范围指定版本时的最小版本号。

1
MaxVersionlong

通过范围指定版本时的最大版本号。

10
DefaultVersionboolean

是否查询默认版本。

true
DetailFlagboolean

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

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

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

默认值:true。

true
PageNumberinteger

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

起始值:1。

默认值:1。

1
PageSizeinteger

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

默认值:10。

10

返回参数

名称类型描述示例值
object

test

PageSizeinteger

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

10
RequestIdstring

请求 ID。

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

当前页码。

1
TotalCountinteger

实例启动模板总数。

1
LaunchTemplateVersionSetsobject []

关于模板版本的信息。

LaunchTemplateNamestring

模板名称。

testLaunchTemplateName
DefaultVersionboolean

模板是否为默认版本。

true
VersionNumberlong

模板版本号。

1
ModifiedTimestring

模板修改时间。

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

模板 ID。

lt-bp67acfmxazb4p****
CreateTimestring

模板创建时间。

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

模板的创建者。

123456789****
VersionDescriptionstring

模板版本描述。

testVersionDescription
LaunchTemplateDataobject

模板具体配置。

DeploymentSetIdstring

部署集 ID。

ds-bp1brhwhoqinyjd6****
VpcIdstring

专有网络 VPC ID。

v-bp67acfmxazb4p****
SystemDisk.PerformanceLevelstring

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

  • PL0(默认):单盘最高随机读写 IOPS 1 万。
  • PL1:单盘最高随机读写 IOPS 5 万。
  • PL2:单盘最高随机读写 IOPS 10 万。
  • PL3:单盘最高随机读写 IOPS 100 万。

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

PL0
KeyPairNamestring

密钥对名称。

testKeyPairName
SecurityGroupIdstring

实例的安全组 ID。

说明 SecurityGroupIdSecurityGroupIds不会同时返回值。
sg-bp67acfmxazb4p****
NetworkTypestring

网络类型。可能值:

  • classic:经典网络。
  • vpc:专有网络 VPC。
vpc
SpotStrategystring

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

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
NoSpot
EnableVmOsConfigboolean

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

false
Descriptionstring

实例描述。

testInstanceDescription
SpotDurationinteger

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

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

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

说明 当 SpotStrategy 值为 SpotWithPriceLimit 或 SpotAsPriceGo 时返回该参数。
1
InstanceNamestring

实例名称。

testInstanceName
SecurityEnhancementStrategystring

是否开启安全加固。

active
UserDatastring

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

SGVsbG9FQ1M=
SystemDisk.DiskNamestring

系统盘名称。

testSystemDiskName
SystemDisk.Sizeinteger

系统盘大小,单位:GiB。

40
SpotPriceLimitfloat

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

0.98
PasswordInheritboolean

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

true
PrivateIpAddressstring

实例私网 IP 地址。

10.1.**.**
ImageIdstring

实例使用的镜像 ID。

m-bp67acfmxazb4p****
SystemDisk.DeleteWithInstanceboolean

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

  • true:随实例释放。

  • false:不随实例释放。

true
SystemDisk.Categorystring

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

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。您可以通过参数 SystemDisk.PerformanceLevel 设置云盘的性能等级。

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

cloud_ssd
AutoReleaseTimestring

自动释放时间。

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

系统盘描述。

testSystemDiskDescription
ImageOwnerAliasstring

镜像来源。可能值:

  • system:阿里云提供的公共镜像。
  • self:您创建的自定义镜像。
  • others:其他阿里云用户共享给您的镜像。
  • marketplace:云市场镜像。
system
HostNamestring

实例主机名。

testHostName
SystemDisk.Iopsinteger

系统盘总 IOPS。

101800
SystemDisk.AutoSnapshotPolicyIdstring

自动快照策略 ID。

sp-bp1j0alc2z1fhvie****
InternetMaxBandwidthOutinteger

公网出带宽最大值。

100
InternetMaxBandwidthIninteger

公网入带宽最大值。

5
InstanceTypestring

实例规格。

ecs.g5.large
Periodinteger

购买资源的时长。

1
InstanceChargeTypestring

实例计费类型。可能值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。
Postpaid
IoOptimizedstring

是否为 I/O 优化实例。

none
RamRoleNamestring

实例 RAM 角色名称。

testRamRoleName
VSwitchIdstring

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

vsw-bp67acfmxazb4p****
ResourceGroupIdstring

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

rg-bp67acfmxazb4p****
InternetChargeTypestring

公网带宽计费方式。

PayByTraffic
ZoneIdstring

可用区 ID。

cn-hangzhou-g
Ipv6AddressCountinteger

实例的 IPv6 地址数量。

1
DataDisksobject []

数据盘集合。

PerformanceLevelstring

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

  • PL0:单盘最高随机读写 IOPS 1 万。
  • PL1:单盘最高随机读写 IOPS 5 万。
  • PL2:单盘最高随机读写 IOPS 10 万。
  • PL3:单盘最高随机读写 IOPS 100 万。
PL1
Descriptionstring

数据盘描述。

testDiskDescription
SnapshotIdstring

数据盘使用的快照 ID。

s-bp67acfmxazb4p****
Devicestring

数据盘的设备名。

说明 该参数即将停止使用,为提高代码兼容性,建议您尽量不要使用该参数。
/dev/xvda
Sizeinteger

数据盘大小。

2000
DiskNamestring

数据盘名称。

testDiskName
Categorystring

数据盘的云盘种类。

cloud_ssd
DeleteWithInstanceboolean

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

true
Encryptedstring

数据盘是否加密。

false
ProvisionedIopslong

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

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

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

是否开启 Burst(性能突发)。取值范围:

  • true:是。
  • false:否。
true
AutoSnapshotPolicyIdstring

自动快照策略 ID。

sp-wz91dz3ghear2a5s****
NetworkInterfacesobject []

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

NetworkInterfaceNamestring

辅助弹性网卡名称。

testNetworkInterfaceName
VSwitchIdstring

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

vsw-bp67acfmxazb4p****
Descriptionstring

辅助弹性网卡描述信息。

testNetworkInterfacesDescription
PrimaryIpAddressstring

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

203.0.*.*
SecurityGroupIdstring

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

说明 SecurityGroupId 和 SecurityGroupIds 不会同时返回值。
sg-bp67acfmxazb4p****
SecurityGroupIdsarray

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

说明 SecurityGroupId 和 SecurityGroupIds 不会同时返回值。
string

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

说明 SecurityGroupId 和 SecurityGroupIds 不会同时返回值。
["sg-bp15ed6xe1yxeycg7****"]
InstanceTypestring

实例的规格。

ecs.s2.xlarge
NetworkInterfaceTrafficModestring

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

  • Standard:使用 TCP 通讯模式。
  • HighPerformance:开启 ERI(Elastic RDMA Interface)接口,使用 RDMA 通讯模式。
Standard
Tagsobject []

实例的标签列表。

Keystring

实例的标签键。

TestKey
Valuestring

实例的标签值。

TestValue
SecurityGroupIdsarray

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

说明 SecurityGroupIdSecurityGroupIds不会同时返回值。
string

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

说明 SecurityGroupIdSecurityGroupIds不会同时返回值。
["sg-bp15ed6xe1yxeycg7****"]
SystemDisk.ProvisionedIopslong

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

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

说明 当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘修改 ESSD AutoPL 云盘预配置信息
50000
SystemDisk.BurstingEnabledboolean

是否开启 Burst(性能突发)。取值范围:

  • true:是。
  • false:否。
true
SystemDisk.Encryptedstring

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

  • true:加密。
  • false:不加密。

默认值:false。

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

实例释放保护属性,指定是否支持通过控制台或 API( DeleteInstance )释放实例。取值范围:

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

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

默认值:false。

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

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

Standard
AutoRenewboolean

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

  • true:自动续费。
  • false:不自动续费。

默认值:false。

true
AutoRenewPeriodinteger

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

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

默认值:1。

1
PeriodUnitstring

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

Month(默认)。

Month

示例

正常返回示例

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/xvda",
                "Size": 2000,
                "DiskName": "testDiskName",
                "Category": "cloud_ssd",
                "DeleteWithInstance": true,
                "Encrypted": "false",
                "ProvisionedIops": 50000,
                "BurstingEnabled": true,
                "AutoSnapshotPolicyId": "sp-wz91dz3ghear2a5s****"
              }
            ]
          },
          "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"
              }
            ]
          },
          "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"
        }
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-05-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-10-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-08-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-03-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
2022-07-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-12-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更