DescribeLaunchTemplates - 查询实例启动模板--云服务器-火山引擎

文档中心

导航

云服务器

DescribeLaunchTemplates - 查询实例启动模板

最近更新时间：2024.08.15 14:19:16首次发布时间：2024.08.15 14:19:16

调用 DescribeLaunchTemplates 接口查询实例启动模板。

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeLaunchTemplates	要执行的操作，取值：DescribeLaunchTemplates。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
LaunchTemplateIds.N	String	否	LaunchTemplateIds.1=lt-3ti78x9h8t4bw**&LaunchTemplateIds.2=lt-ysxc16auaugh9zfy**	实例启动模板ID，最多支持10个ID。参数 - N：表示实例启动模板的序号。多个ID之间用&分隔。
LaunchTemplateNames.N	String	否	LaunchTemplateNames.1=testLaunchTemplateName	实例启动模板的名称，最多支持10个。参数 - N：表示实例启动模板的序号。多个名称之间用&分隔。
NextToken	String	否	-	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
MaxResults	Integer	否	10	分页查询时设置的每页行数：最大值：100 默认值：10

返回数据

名称	类型	示例值	描述
NextToken	String	-	本次调用返回的查询凭证值，返回为空表示该页为末页。
LaunchTemplates	Array	-	符合条件的实例启动模板信息。具体请参见下表“LaunchTemplates 结构”。

LaunchTemplates 结构

名称	类型	示例值	描述
LaunchTemplateId	String	lt-ysxc16auaugh9zfy****	实例启动模板ID。
LaunchTemplateName	String	testLaunchTemplateName	实例启动模板名称。
DefaultVersionNumber	Integer	1	模板默认版本号。
LatestVersionNumber	Integer	1	模板最新版本号。
CreatedAt	String	2022-06-09 10:38:20	实例启动模板的创建时间。
UpdatedAt	String	2022-06-09 10:38:20	实例启动模板的更新时间。

请求示例

GET /?Action=DescribeLaunchTemplates&Version=2020-04-01&LaunchTemplateIds.1=lt-ysxc16auaugh9zfy**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220419160338010225133143077B****",
        "Action": "DescribeLaunchTemplates",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 0,
        "PageSize": 0,
        "TotalCount": 1,
        "LaunchTemplates": [
            {
                "LaunchTemplateId": "lt-ysxc16auaugh9zfy****",
                "LaunchTemplateName": "testLaunchTemplateName",
                "DefaultVersionNumber": 1,
                "LatestVersionNumber": 1,
                "CreatedAt": "2022-06-09 10:38:20",
                "UpdatedAt": "2022-06-09 10:38:20"
            }
        ]
    }
}

错误码

HttpCode	错误码	错误信息	描述
400	MissingParameter.AccountId	The required parameter AccountId is not supplied.	账户ID不能为空。
400	QuotaExceeded.TemplateQuota	You've reached the limit on the Quota.	该账号下实例启动模板数量超限额。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。