調用GetTemplate介面擷取模板詳情-Resource Orchestration Service-阿里雲 - Resource Orchestration Service

指定資源棧、資源棧組、更改集、自訂模板其中任意資訊擷取模板詳情。

介面說明

本文將提供一個樣本，查詢杭州地區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

stack

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

template

acs:ros:*:{#accountId}:template/{#templateId}

無

請求參數

名稱	類型	必填	描述	樣本值
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 時生效。如果為共用模板，僅當共用模板中的 VersionOption 取值為 AllVersions 時，支援指定該參數。更多資訊，請參見 SetTemplatePermission . 取值範圍：v1～v65000、Draft。共用模板取值範圍：v1～v65000。	v1
TemplateStage	string	否	模板階段。僅在指定 StackId、ChangeSetId 或 StackGroupName 時生效。取值： Processed（預設值）：返回解析轉換後的模板。 Original：返回使用者指定的原始模板。	Processed
IncludePermission	string	否	是否查詢範本共用資訊。取值： Enabled：查詢。 Disabled（預設值）：不查詢。說明僅限模板擁有者查詢。	Enabled
StackGroupName	string	否	資源棧組名稱。說明您必須且僅能指定 StackId、ChangeSetId、StackGroupName 和 TemplateId 其中一個參數。	MyStackGroup
IncludeTags	string	否	是否查詢標籤資訊。取值： Enabled：查詢。 Disabled（預設值）：不查詢。說明僅在指定 TemplateId 參數時生效。	Enabled

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

返回參數

名稱	類型	描述	樣本值
	object
TemplateARN	string	模板 ARN。僅在指定 TemplateId 時返回該參數。	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
Description	string	模板描述。僅在指定 TemplateId 時返回該參數。	ROS template for create ECS instance.
RequestId	string	請求 ID。	B288A0BE-D927-4888-B0F7-B35EF84****
CreateTime	string	模板建立時間。僅在指定 TemplateId 時返回該參數。說明如果指定了 TemplateVersion，則返回指定版本模板的建立時間。如果未指定 TemplateVersion，則返回預設版本模板的建立時間。	2020-11-18T08:49:26
StackGroupName	string	資源棧組名稱。僅在指定 StackGroupName 時返回該參數。	MyStackGroup
TemplateVersion	string	模板版本。僅在指定 TemplateId 時返回該參數。如果未指定 TemplateVersion，或 TemplateVersion 未生效，則該參數表示模板目前的版本。如果為共用模板，若且唯若 VersionOption 為 AllVersions 時，支援返回該參數。	v1
TemplateBody	string	模板內容。	{"ROSTemplateFormatVersion": "2015-09-01"}
ChangeSetId	string	更改集 ID。僅在指定 ChangeSetId 時返回該參數。	e85abe0c-6528-43fb-ae93-fdf8de22****
OwnerId	string	模板所屬阿里雲帳號 ID。僅在指定 TemplateId 時返回該參數。	151266687691****
UpdateTime	string	模板的最後更新時間。僅在指定 TemplateId 時返回該參數。說明如果指定了 TemplateVersion，則返回指定版本模板的最後更新時間。如果未指定 TemplateVersion，則返回模板的最後更新時間。	2020-12-07T06:11:48
Permissions	array<object>	模板的共用狀態。僅在指定 TemplateId，且 IncludePermission 為 Enabled 時返回該參數。說明如果未指定 TemplateVersion，或者 TemplateVersion 不生效，則返回模板的共用狀態。如果指定了 TemplateVersion，並且 TemplateVersion 生效，則返回版本關聯模板的共用狀態。
	object
VersionOption	string	共用版本選項。僅在 ShareOption 取值為 ShareToAccounts 時返回該參數。取值： AllVersions：共用模板所有版本。 Latest：只共用模板最新版本。模板版本增加時，共用的版本也隨之變化，始終保持最新版本。 Current：只共用模板當前最新版本。模板版本增加時，共用的版本不變。 Specified：只共用模板指定的單個版本。	AllVersions
AccountId	string	共用的阿里雲帳號。	142437958638****
ShareOption	string	共用選項。取值：ShareToAccounts，表示共用給其他阿里雲帳號。	ShareToAccounts
TemplateVersion	string	共用的模板版本。當 ShareOption 為 ShareToAccounts，且 VersionOption 為 Specified 或 Current 時返回該參數。當指定參數 TemplateVersion 為 Draft 時，如果 Draft 版本存在，則該傳回值為 Draft；如果 Draft 版本不存在或已被清除，則該傳回值為當前最新版本。取值範圍：v1~v65000、Draft。	v1
ShareSource	string	共用關係的建立來源。取值： ROS：通過 ROS 控制台或 API 建立共用關係。 ResourceDirectory：在資源管理服務中通過資源共用功能為資來源目錄中的帳號建立共用關係。說明來自 ROS 的共用與來自 ResourceDirectory 的共用擁有獨立的配額。無法通過 ROS 控制台或 API 取消或覆蓋來自 ResourceDirectory 的共用。來自 ResourceDirectory 的共用可以覆蓋來自 ROS 的共用。	ROS
TemplateName	string	模板的名稱。僅在指定 TemplateId 時返回該參數。說明如果指定了 TemplateVersion，則返回版本關聯的模板名稱。如果未指定 TemplateVersion，則返回模板的名稱。	MyTemplate
RegionId	string	模板所屬資源棧或資源棧組的地區 ID。僅在指定 StackId、ChangeSetId 或 StackGroupName 時返回該參數。	cn-hangzhou
TemplateId	string	模板的 ID。僅在指定 TemplateId 時返回。如果是共用模板，返回結果與 TemplateARN 相同。	a52f81be-496f-4e1c-a286-8852ab54****
StackId	string	資源棧 ID。僅在指定 StackId 時返回該參數。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ShareType	string	模板的共用類型。僅在指定 TemplateId 時返回該參數。取值： Private：模板為使用者自己所擁有。 Shared：模板由其他使用者所共用。	Private
ResourceGroupId	string	資源群組 ID。	rg-acfmxazb4ph6aiy****
Interface	string	介面描述資訊。	{}
Tags	array<object>	模板的標籤。
	object	模板的標籤。
Key	string	模板的標籤鍵。	usage
Value	string	模板的標籤值。	test
AdditionalInfo	object	公用模板的補充資訊。	{"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":["other"]},"Provider":"ROS","Categories":["Solution"]}

樣本

正常返回樣本

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": [
        "other"
      ]
    },
    "Provider": "ROS",
    "Categories": [
      "Solution"
    ]
  }
}

錯誤碼

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

變更歷史

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