調用GetTemplateSummary擷取模板摘要-Resource Orchestration Service-阿里雲 - Resource Orchestration Service

通過指定模板、資源棧、資源棧組、更改集其中任意資訊查詢範本資源詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ros:GetTemplateSummary

get

Stack

acs:ros:{#regionId}:{#accountId}:stack/{#StackId}

無

請求參數

名稱	類型	必填	描述	樣本值
StackId	string	否	資源棧 ID。您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個參數。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
TemplateBody	string	否	模板的結構。長度為 1~524,288 個位元組。如果長度較大，建議通過 HTTP POST+Body Param 的方式，將參數放在請求體中進行傳遞，避免 URL 過長而導致請求失敗。您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個參數。	{"ROSTemplateFormatVersion":"2015-09-01"}
RegionId	string	否	模板所屬資源棧或資源棧組的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。僅在指定 StackId、ChangeSetId 或 StackGroupName 時生效。	cn-hangzhou
TemplateId	string	否	模板 ID。支援共用模板和私人模板。您僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個參數。	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateURL	string	否	包含模板主體的檔案的位置。URL 必須指向位於 Web 服務器（HTTP 或 HTTPS）或阿里雲 OSS 儲存空間（例如：oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou）中的模板，模板最大為 524,288 個位元組。說明如果 OSS 地區未指定，預設與介面參數 RegionId 相同。您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個參數。 URL 的最大長度為：1024 個位元組。	oss://ros/template/demo
ChangeSetId	string	否	更改集 ID。您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個參數。	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateVersion	string	否	模板版本。當您設定 TemplateId 參數時，本參數生效。	v1
StackGroupName	string	否	資源棧組名稱。您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個參數。	my-stack-group
Parameters	array<object>	否	模板中已定義的參數。
	object	否
ParameterKey	string	否	模板中已定義的參數的名稱。如果您未指定參數的名稱和值時，ROS 將使用模板中指定的預設值。 N 最大值為 200。說明 Parameters 為選擇性參數。如果需要指定 Parameters，則 Parameters.N.ParameterKey 和 Parameters.N.ParameterValue 必須同時指定。	InstanceId
ParameterValue	string	否	模板中已定義的參數的取值。 N 最大值為 200。說明 Parameters 為選擇性參數。如果需要指定 Parameters，則 Parameters.N.ParameterKey 和 Parameters.N.ParameterValue 必須同時指定。	i-rotp2e20whfrs2****
ClientToken	string	否	保證請求的等冪性。該參數值由用戶端產生，並且必須全域唯一。長度不超過 64 個字元。可包含英文字母、數字、短劃線（-）和底線（_）。更多資訊，請參見如何保證等冪性。	123e4567-e89b-12d3-a456-42665544****

關於公用請求參數的詳情，請參見公用參數。

返回參數

名稱	類型	描述	樣本值
	object
ResourceTypes	array	模板中用到的所有資源類型。
	string	模板中用到的所有資源類型。	["ALIYUN::ECS::VPC"]
Description	string	資源棧模板的描述資訊。	No description
Parameters	array<object>	參數聲明的列表。
	object	參數聲明的列表。	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]
RequestId	string	請求 ID。	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Version	string	模板版本。	2015-09-01
Metadata	object	模板中定義的中繼資料。	{"key": "value"}
ResourceIdentifierSummaries	array<object>	資源標識符摘要的列表。摘要描述了匯入操作的目標資源以及在匯入處理程序中用於標識目標資源的屬性。例如：VpcId 是 ALIYUN::ECS::VPC 資源的標識符屬性。
	object
ResourceType	string	資源類型。說明該資源類型支援資源匯入。	ALIYUN::ECS::VPC
LogicalResourceIds	array	模板中類型為 ResourceType 的所有資源的邏輯 ID。
	string	模板中類型為 ResourceType 的所有資源的邏輯 ID。	["Vpc"]
ResourceIdentifiers	array	資源屬性。用來標識目標資源。例如：VpcId 是 ALIYUN::ECS::VPC 資源的標識符屬性。
	string	資源屬性。用來標識目標資源。例如：VpcId 是 ALIYUN::ECS::VPC 資源的標識符屬性。	["VpcId"]

樣本

正常返回樣本

JSON格式

{
  "ResourceTypes": [
    "[\"ALIYUN::ECS::VPC\"]"
  ],
  "Description": "No description",
  "Parameters": [
    [
      {
        "Description": "",
        "Label": "Name",
        "NoEcho": "false",
        "ParameterKey": "Name",
        "Type": "String"
      }
    ]
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "Version": "2015-09-01",
  "Metadata": {
    "key": "value"
  },
  "ResourceIdentifierSummaries": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceIds": [
        "[\"Vpc\"]"
      ],
      "ResourceIdentifiers": [
        "[\"VpcId\"]"
      ]
    }
  ]
}

錯誤碼

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

變更歷史

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