調用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 錯誤碼發生變更 | 查看變更詳情 |