操作指南

最佳实践

故障处理

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口(DescribeLaunchTemplates)用于查询一个或者多个实例启动模板。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLaunchTemplates。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
LaunchTemplateIds.N Array of String 启动模板ID,一个或者多个启动模板ID。若未指定,则显示用户所有模板。
Filters.N Array of Filter

按照【LaunchTemplateName】进行过滤。

类型:String

必选:否


每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定LaunchTemplateIdsFilters
Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的实例模板数量。
注意:此字段可能返回 null,表示取不到有效值。
LaunchTemplateSet Array of LaunchTemplateInfo 实例详细信息列表。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例启动模板

输入示例

GET POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLaunchTemplates
<公共请求参数>

{
    "LaunchTemplateIds": [
        "lt-q9t8j8eg"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "LaunchTemplateSet": [
            {
                "LatestVersionNumber": 12,
                "LaunchTemplateId": "lt-q9t8j8eg",
                "LaunchTemplateName": "未命名foo\"'\"'''\"\"",
                "DefaultVersionNumber": 5,
                "LaunchTemplateVersionCount": 8,
                "CreatedBy": "251009920",
                "CreationTime": "2020-12-16T08:05:02Z"
            }
        ],
        "RequestId": "b2d70642-c69a-4115-ae4e-f6ddade68fea"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidFilter 无效的过滤器。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidLaunchTemplateName 实例启动模板名称格式错误。
InvalidParameterValue.LaunchTemplateIdMalformed 实例启动模板ID格式错误。
InvalidParameterValue.LaunchTemplateIdNotExisted 实例启动模板ID不存在。
InvalidParameterValue.LaunchTemplateIdVerNotExisted 实例启动模板和版本ID组合不存在。
InvalidParameterValue.LaunchTemplateNotFound 实例启动模板未找到。
InvalidParameterValue.LaunchTemplateVersion 无效的实例启动模板版本号。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
目录