调用DescribeLaunchTemplates接口，并可以指定TemplateTag、TemplateResourceGroupId、LaunchTemplateId等参数，查询一个或多个实例启动模板的信息，例如启动模板总个数、模板创建时间、模板最新版本号等信息集合。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DescribeLaunchTemplates | get | LaunchTemplate acs:ecs:{#regionId}:{#accountId}:launchtemplate/*LaunchTemplate acs:ecs:{#regionId}:{#accountId}:launchtemplate/{#launchtemplateId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| TemplateTag | array<object> | 否 | 启动模版自身的标签对信息列表。 说明
当前仅支持通过 API 创建和查询启动模板的标签，控制台无法创建或查看。
| |
| object | 否 | 启动模版自身的标签对信息。 | ||
| Key | string | 否 | 启动模板的标签键。N 的取值范围：1~20。 使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。 | TestKey |
| Value | string | 否 | 启动模板的标签值。N 的取值范围：1~20。 | TestValue |
| PageNumber | integer | 否 | 实例启动模板列表的页码。起始值：1。 默认值：1。 | 1 |
| PageSize | integer | 否 | 分页查询时设置的每页行数。 默认值：10。 | 10 |
| TemplateResourceGroupId | string | 否 | 启动模板所在的企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。 说明
不支持默认资源组过滤。
| rg-acfmxazb4p**** |
| LaunchTemplateId | array | 否 | 一个或多个实例启动模板 ID 数组。
| |
| string | 否 | 实例启动模板 ID。
| lt-m5e3ofjr1zn1aw7q**** | |
| LaunchTemplateName | array | 否 | 一个或多个实例启动模板名称数组。
| |
| string | 否 | 实例启动模板的名称。
| wd-152630748**** |
返回参数
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE12CBA",
"PageNumber": 1,
"TotalCount": 1,
"LaunchTemplateSets": {
"LaunchTemplateSet": [
{
"LaunchTemplateName": "wd-152630748****",
"DefaultVersionNumber": 1,
"ModifiedTime": "2018-05-14T14:18:00Z",
"LaunchTemplateId": "lt-m5e3ofjr1zn1aw7q****",
"CreateTime": "2018-05-14T14:18:00Z",
"ResourceGroupId": "rg-acfmxazb4p****",
"CreatedBy": "20169351435666****",
"LatestVersionNumber": 1,
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidRegion.NotExist | %s | 指定的地域不存在，请确认参数是否正确。 |
| 400 | MissingParameter | %s | 缺失参数，请检查参数是否完整。 |
| 400 | InvalidParameter | %s | 无效的参数。 |
| 403 | InnerServiceFailed | %s | 内部服务调用失败。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误，请重试。 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 请求后端超时，请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-28 | OpenAPI 错误码发生变更 | 查看变更详情 |