調用GenerateTemplateByScratch為資源情境產生模板-Resource Orchestration Service-阿里雲 - Resource Orchestration Service

介面說明

本文將提供一個樣本，在杭州地區為資源納管類型的資源情境ts-aa9c62feab844a6b****產生模板。

說明

資源探查類型的資源情境不支援產生模板。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ros:GenerateTemplateByScratch

list

*TemplateScratch

acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	資源情境所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
TemplateScratchId	string	是	資源情境 ID。關於如何擷取資源情境 ID，請參見 ListTemplateScratches 。	ts-aa9c62feab844a6b****
ProvisionRegionId	string	否	新節點所屬的地區 ID。	cn-hangzhou
TemplateType	string	否	產生模板類型，支援產生 ROS 和 Terraform 類型的模板，預設為 ROS。	ROS

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

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	D22C1D13-D74E-558C-AF68-1B4C05FA6F1A
TemplateBody	string	資源情境中產生的模板內容。	{\"ROSTemplateFormatVersion\": \"2015-09-01\", \"Resources\": {\"ECSVPC_001\": {\"DeletionPolicy\": \"Retain\", \"Type\": \"ALIYUN::ECS::VPC\", \"Properties\": {\"CidrBlock\": \"172.16.0.0/12\", \"VpcName\": \"MyTestVpc\", \"EnableIpv6\": false}}}}
ResourcesToImport	array<object>	資源納管類型的資源情境中，待匯入資源棧的資源。說明僅資源納管類型的資源情境支援返回該參數。
	array<object>
ResourceType	string	資源類型。	ALIYUN::ECS::VPC
LogicalResourceId	string	資源邏輯 ID。	ECSVPC_001
ResourceIdentifier	object	字串到字串的索引值映射。取值是 JSON 格式的字串，用來標識要匯入的資源。鍵是資源的標識符屬性（例如：ALIYUN::ECS::VPC 資源的 VpcId），值是屬性的取值（例如：`vpc-bp1m6fww66xbntjyc****"`）。	{"VpcId": "vpc-bp1m6fww66xbntjyc****" }

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D22C1D13-D74E-558C-AF68-1B4C05FA6F1A",
  "TemplateBody": "{\\\"ROSTemplateFormatVersion\\\": \\\"2015-09-01\\\", \\\"Resources\\\": {\\\"ECSVPC_001\\\": {\\\"DeletionPolicy\\\": \\\"Retain\\\", \\\"Type\\\": \\\"ALIYUN::ECS::VPC\\\", \\\"Properties\\\": {\\\"CidrBlock\\\": \\\"172.16.0.0/12\\\", \\\"VpcName\\\": \\\"MyTestVpc\\\", \\\"EnableIpv6\\\": false}}}}",
  "ResourcesToImport": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceId": "ECSVPC_001",
      "ResourceIdentifier": {
        "VpcId": "vpc-bp1m6fww66xbntjyc****"
      }
    }
  ]
}

錯誤碼

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

變更歷史

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