指定資源棧、資源棧組、更改集、自定義模板其中任意信息獲取模板詳情。
接口說明
本文將提供一個示例，查詢杭州地域cn-hangzhou模板 ID 為5ecd1e10-b0e9-4389-a565-e4c15efc****的模板詳細信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ros:GetTemplate | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| StackId | string | 否 | 資源棧 ID。 說明
您必須且僅能指定 StackId、ChangeSetId、StackGroupName 和 TemplateId 其中一個參數。
| 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
| RegionId | string | 是 | 模板所屬資源棧或資源棧組的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ChangeSetId | string | 否 | 更改集 ID。 說明
您必須且僅能指定 StackId、ChangeSetId、StackGroupName 和 TemplateId 其中一個參數。
| 1f6521a4-05af-4975-afe9-bc4b45ad**** |
| TemplateId | string | 否 | 模板 ID。 支持共享的模板和私有模板。共享模板 TemplateId 與 TemplateARN 相同，使用該值查詢。 說明
您必須且僅能指定 StackId、ChangeSetId、StackGroupName 和 TemplateId 其中一個參數。
| 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
| TemplateVersion | string | 否 | 模板版本。僅在指定 TemplateId 時生效。 取值范圍：v1～v65000、Draft。 共享模板取值范圍：v1～v65000。 | v1 |
| TemplateStage | string | 否 | 模板階段。僅在指定 StackId、ChangeSetId 或 StackGroupName 時生效。 取值：
| Processed |
| IncludePermission | string | 否 | 是否查詢模板共享信息。取值：
說明
僅限模板擁有者查詢。
| Enabled |
| StackGroupName | string | 否 | 資源棧組名稱。 說明
您必須且僅能指定 StackId、ChangeSetId、StackGroupName 和 TemplateId 其中一個參數。
| MyStackGroup |
| IncludeTags | string | 否 | 是否查詢標簽信息。取值：
說明
僅在指定 TemplateId 參數時生效。
| Enabled |
關于公共請求參數的詳情，請參見公共參數。
返回參數
示例
正常返回示例
JSON格式
{
"TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
"Description": "ROS template for create ECS instance.",
"RequestId": "B288A0BE-D927-4888-B0F7-B35EF84****",
"CreateTime": "2020-11-18T08:49:26",
"StackGroupName": "MyStackGroup",
"TemplateVersion": "v1",
"TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
"ChangeSetId": "e85abe0c-6528-43fb-ae93-fdf8de22****",
"OwnerId": "151266687691****",
"UpdateTime": "2020-12-07T06:11:48",
"Permissions": [
{
"VersionOption": "AllVersions",
"AccountId": "142437958638****",
"ShareOption": "ShareToAccounts",
"TemplateVersion": "v1",
"ShareSource": "ROS"
}
],
"TemplateName": "MyTemplate",
"RegionId": "cn-hangzhou",
"TemplateId": "a52f81be-496f-4e1c-a286-8852ab54****",
"StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****\t",
"ShareType": "Private",
"ResourceGroupId": "rg-acfmxazb4ph6aiy****",
"Interface": "{}",
"Tags": [
{
"Key": "usage",
"Value": "test"
}
],
"AdditionalInfo": {
"DeploymentDuration": null,
"Title": "Self-Built_ElasticSearch_Snapshot_Saved_To_OSS",
"Labels": {
"ResourceTypes": [
"ALIYUN::ECS::Instance",
"ALIYUN::ECS::SecurityGroup",
"ALIYUN::ECS::VPC",
"ALIYUN::ECS::VSwitch",
"ALIYUN::OSS::Bucket",
"ALIYUN::ROS::WaitCondition",
"ALIYUN::ROS::WaitConditionHandle"
],
"DeployTypes": [
"ROS"
],
"ApplicationScenes": [
"其他"
]
},
"Provider": "ROS",
"Categories": [
"Solution"
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-28 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2022-06-09 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| HttpCode | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 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 Template { ID } could not be found. | 模板不存在。ID 為模板 ID。 |
| 404 | TemplateNotFound | The Template { ID } with version { version } could not be found. | 模板或指定版本不存在。ID 為模板 ID，version 為模板版本。 |
| 404 | StackGroupNotFound | The StackGroup ({name}) could not be found. | 資源棧組不存在。name 為資源棧組名稱。 |