通過指定模板、資源棧、資源棧組、更改集其中任意信息查詢模板資源詳情。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ros:GetTemplateSummary | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| StackId | string | 否 | 資源棧 ID。 您必須且僅能指定 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、StackGroupName 其中一個參數。 | 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
| TemplateBody | string | 否 | 模板的結構。長度為 1~524,288 個字節。 | {"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 | 否 | 保證請求的冪等性。該參數值由客戶端生成，并且必須全局唯一。 | 123e4567-e89b-12d3-a456-42665544**** |
關于公共請求參數的詳情，請參見公共參數。
返回參數
示例
正常返回示例
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\"]"
]
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
| HttpCode | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | StackValidationFailed | {reason}. | 資源棧校驗失敗。reason 為具體原因。 |
| 404 | ChangeSetNotFound | The ChangeSet ({name}) of Stack ({stack}) could not be found. | 更改集不存在。name 為更改集名稱或 ID，stack 為資源棧名稱或 ID。 |
| 404 | ChangeSetNotFound | The ChangeSet {ID} could not be found. | 更改集不存在。ID 為更改集 ID。 |
| 404 | StackNotFound | The Stack ({name}) could not be found. | 資源棧不存在。name 為資源棧名稱或 ID。 |
| 404 | TemplateNotFound | The Tempalte ({ ID }) could not be found. | 模板不存在。ID 為模板 ID。 |
| 404 | TemplateNotFound | The Template { ID } with version { version } could not be found. | 模板或指定版本不存在。ID 為模板 ID，version 為模板版本。 |