调用DescribeLaunchTemplates查询一个或多个可用的实例启动模板。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLaunchTemplates

系统规定参数。取值:DescribeLaunchTemplates

RegionId String cn-hangzhou

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

TemplateTag.N.Key String TestKey

启动模板的标签键。N的取值范围:1~20

TemplateTag.N.Value String TestValue

启动模板的标签值。N的取值范围:1~20

LaunchTemplateId.N RepeatList lt-m5e3ofjr1zn1aw7q****

一个或多个实例启动模板ID,最多支持查询100个启动模板。您必须指定LaunchTemplateId或LaunchTemplateName以确定模板。

LaunchTemplateName.N RepeatList wd-152630748****

一个或多个实例启动模板名称,最多支持查询100个启动模板。

PageNumber Integer 1

实例启动模板列表的页码。起始值:1

默认值:1

PageSize Integer 10

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

默认值:10

TemplateResourceGroupId String rg-acfmxazb4p****

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

返回数据

名称 类型 示例值 描述
LaunchTemplateSets Array

实例启动模板的信息集合。

LaunchTemplateSet
CreateTime String 2018-05-14T14:18:00Z

实例启动模板创建时间。

CreatedBy String 1234567890

模板的创建者。

DefaultVersionNumber Long 1

模板默认版本号。

LatestVersionNumber Long 1

模板最新版本号。

LaunchTemplateId String lt-m5e3ofjr1zn1aw7q****

模板ID。

LaunchTemplateName String wd-152630748****

模板名称。

ModifiedTime String 2018-05-14T14:18:00Z

修改时间。

ResourceGroupId String rg-acfmxazb4p****

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

Tags Array

启动模板的标签对属性。

Tag
TagKey String TestKey

启动模板的标签键。

TagValue String TestValue

启动模板的标签值。

PageNumber Integer 1

当前页码。

PageSize Integer 10

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

RequestId String 04F0F334-1335-436C-A1D7-6C044FE12CBA

请求ID。

TotalCount Integer 1

实例启动模板总个数。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeLaunchTemplates
&RegionId=cn-hangzhou
&TemplateTag.1.Key=TestKey
&TemplateTag.1.Value=TestValue
&LaunchTemplateId.1=lt-m5e3ofjr1zn1aw7q****
&LaunchTemplateName.1=wd-152630748****
&PageNumber=1
&PageSize=10
&TemplateResourceGroupId=rg-acfmxazb4p****
&<公共请求参数>

正常返回示例

XML 格式

<DescribeLaunchTemplatesResponse>
	  <RequestId>04F0F334-1335-436C-A1D7-6C044FE12CBA</RequestId>
	  <TotalCount>1</TotalCount>
	  <PageNumber>1</PageNumber>
	  <PageSize>10</PageSize>
	  <LaunchTemplateSets>
		    <LaunchTemplateSet>
			      <CreateTime>2018-05-14T14:18:00Z</CreateTime>
			      <ModifiedTime>2018-05-14T14:18:00Z</ModifiedTime>
			      <LaunchTemplateid>lt-m5e3ofjr1zn1aw7****</LaunchTemplateid>
			      <LaunchTemplateName>wd-152630748****</LaunchTemplateName>
			      <DefaultVersionNumber>1</DefaultVersionNumber>
			      <LatestVersionNumber>1</LatestVersionNumber>
			      <CreatedBy>194211134971****</CreatedBy>
		    </LaunchTemplateSet>
	  </LaunchTemplateSets>
</DescribeLaunchTemplatesResponse>

JSON 格式

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE12CBA",
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "LaunchTemplateSets": {
        "LaunchTemplateSet": [
            {
                "LaunchTemplateName": "wd-152630748****",
                "CreatedBy": "194211134971****",
                "ModifiedTime": "2018-05-14T14:18:00Z",
                "LatestVersionNumber": 1,
                "CreateTime": "2018-05-14T14:18:00Z",
                "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7q****",
                "DefaultVersionNumber": 1
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidRegion.NotExist %s 指定的地域不存在,请确认参数是否正确。
400 MissingParameter %s 缺失参数,请检查参数是否完整。
400 InvalidParameter %s 无效的参数。
403 InnerServiceFailed %s 内部服务调用失败。

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