DescribeLaunchTemplates

呼叫 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 陣列。最多支援查詢 100 個啟動範本。您必須指定 LaunchTemplateId 或 LaunchTemplateName 以確定範本。	lt-m5e3ofjr1zn1aw7q****
	string	否	執行個體啟動範本 ID。最多支援查詢 100 個啟動範本。您必須指定 LaunchTemplateId 或 LaunchTemplateName 以確定範本。	lt-m5e3ofjr1zn1aw7q****
LaunchTemplateName	array	否	一個或多個執行個體啟動範本名稱陣列。最多支援查詢 100 個啟動範本。您必須指定 LaunchTemplateId 或 LaunchTemplateName 以確定範本。	wd-152630748****
	string	否	執行個體啟動範本的名稱。最多支援查詢 100 個啟動範本。您必須指定 LaunchTemplateId 或 LaunchTemplateName 以確定範本。	wd-152630748****

返回參數

名稱	類型	描述	樣本值
	object
PageSize	integer	分頁查詢時設定的每頁行數。	10
RequestId	string	請求 ID。	04F0F334-1335-436C-A1D7-6C044FE12CBA
PageNumber	integer	當前頁碼。	1
TotalCount	integer	執行個體啟動範本總個數。	1
LaunchTemplateSets	object
LaunchTemplateSet	array<object>	執行個體啟動範本的資訊集合列表。
	array<object>	執行個體啟動範本的資訊集合。
LaunchTemplateName	string	模板名稱。	wd-152630748****
DefaultVersionNumber	integer	模板預設版本號碼。	1
ModifiedTime	string	模板新增或刪除版本的時間。按照 ISO 8601 標準表示，使用 UTC 時間。格式為：yyyy-MM-ddTHH:mm:ssZ。	2018-05-14T14:18:00Z
LaunchTemplateId	string	模板 ID。	lt-m5e3ofjr1zn1aw7q****
CreateTime	string	啟動模板建立時間。按照 ISO 8601 標準表示，使用 UTC 時間。格式為：yyyy-MM-ddTHH:mm:ssZ。	2018-05-14T14:18:00Z
ResourceGroupId	string	啟動模板所在的企業資源組 ID。	rg-acfmxazb4p****
CreatedBy	string	模板的建立者，即阿里雲帳號 ID。	20169351435666****
LatestVersionNumber	integer	模板最新版本號碼。	1
Tags	object
Tag	array<object>	啟動模版自身的標籤對資訊列表。說明當前僅支援通過 API 建立和查詢啟動模板的標籤，控制台無法建立或查看。
	object	啟動模版自身的標籤對資訊列表。
TagValue	string	啟動模板的標籤鍵。	TestValue
TagKey	string	啟動模板的標籤值。	TestKey

樣本

正常返回樣本

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
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	InnerServiceFailed	%s
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。