透過 GetTemplateScratch API 獲取資源場景詳情 - 資源編排 - 阿里雲 - Resource Orchestration Service

取得資源場景詳情。

介面說明

本文將提供一個範例，查詢杭州地域資源場景ts-7f7a704cf71c49a6****的詳情，並顯示來源節點資料。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ros:GetTemplateScratch

get

*TemplateScratch

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	資源場景所屬的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。	cn-hangzhou
TemplateScratchId	string	否	資源場景 ID。	ts-7f7a704cf71c49a6****
ShowDataOption	string	否	資料顯示選項，取值： Sources：僅顯示來源節點資料，且針對 TemplateScratchType 為 ArchitectureDetection。 Source：僅顯示來源節點資料，且針對 TemplateScratchType 不為 ArchitectureDetection。 Provisions：僅顯示新節點資料，且針對 TemplateScratchType 不為 ArchitectureDetection。 All：顯示所有資料。關於來源節點和新節點的更多資訊，請參閱概覽。說明未設定該參數時，預設不顯示節點資料。	Source

關於公共請求參數的詳情，請參閱公共參數。

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	A8E0EF98-6FBD-5656-8298-FC8194F0F7B7
TemplateScratch	object	資源場景。
TemplateScratchId	string	資源場景 ID。	ts-7f7a704cf71c49a6****
TemplateScratchType	string	資源場景類型，取值： ResourceImport：資源納管。 ArchitectureReplication：資源複製。	ArchitectureReplication
Status	string	資源場景狀態，取值： GENERATE_IN_PROGRESS：產生中。 GENERATE_COMPLETE：產生完成。 GENERATE_FAILED：產生失敗。	GENERATE_COMPLETE
StatusReason	string	資源場景產生失敗的原因。說明僅當 Status 為 GENERATE_FAILED 時傳回該參數。	Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.
FailedCode	string	資源場景產生失敗的狀態碼。說明僅當 Status 為 GENERATE_FAILED 時傳回該參數。	InvalidZoneId
TemplateScratchData	object	資源場景資料。	See the response example.
PreferenceParameters	array<object>	資源場景設定參數。
	object
ParameterKey	string	參數名稱。	DeletionPolicy
ParameterValue	string	參數值。	Retain
Description	string	資源場景說明。	Copy VPC resources.
SourceResources	array<object>	來源資源。
	object	來源資源。
ResourceId	string	資源 ID。	vpc-m5e7cv7e9mz69sszb****
ResourceType	string	資源類型。	ALIYUN::ECS::VPC
RelatedResourceTypeFilter	array	附屬資源類型篩選器。
	string	附屬資源類型篩選器。	ALIYUN::ECS::VPC
SourceTag	object	來源標籤。
ResourceTags	object	源標籤。	{"a": "b"}
ResourceTypeFilter	array	資源類型篩選器。
	string	資源類型篩選器。	ALIYUN::ECS::VPC
SourceResourceGroup	object	來源資源群組。
ResourceGroupId	string	源資源群組 ID。	rg-acfmzawhxxc****
ResourceTypeFilter	array	資源類型篩選器。
	string	資源類型篩選器。	ALIYUN::ECS::VPC
LogicalIdStrategy	string	邏輯 ID 產生策略，取值： LongTypePrefixAndIndexSuffix（預設值）：長類型前綴+索引後綴。 LongTypePrefixAndHashSuffix：長類型前綴+雜湊後綴。 ShortTypePrefixAndHashSuffix：短類型前綴+雜湊後綴。	LongTypePrefixAndIndexSuffix
CreateTime	string	資源場景建立時間。按照 ISO8601 標準表示，使用 UTC+0 時間，但缺少 Z 結尾，格式：YYYY-MM-DDThh:mm:ss。	2021-12-22T01:49:22
UpdateTime	string	資源場景更新時間。按照 ISO8601 標準表示，使用 UTC+0 時間，但缺少 Z 結尾，格式：YYYY-MM-DDThh:mm:ss。	2021-12-22T01:49:23
Stacks	array<object>	資源場景關聯的資源堆疊列表。
	object
StackId	string	資源棧 ID。	3708bf6a-3a67-44d4-9eb1-c56704b9****
RegionId	string	資源棧所屬的地區 ID。	cn-hangzhou
UsageType	string	資源棧用途，取值： ResourceImport：資源納管。 ArchitectureReplication：資源複製。	ArchitectureReplication
StackProvision	object	資源堆疊預置資訊。
Creatable	boolean	是否支援通過 CreateStack 建立資源棧以進行資源複製，取值： true：支援。 false：不支援。	true
Importable	boolean	是否支援通過 CreateChangeSet 建立更改集以進行資源納管，取值： true：支援。 false：不支援。	false
ResourceGroupId	string	資源群組 ID。	rg-acfmzmhzoaad5oq

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A8E0EF98-6FBD-5656-8298-FC8194F0F7B7",
  "TemplateScratch": {
    "TemplateScratchId": "ts-7f7a704cf71c49a6****",
    "TemplateScratchType": "ArchitectureReplication",
    "Status": "GENERATE_COMPLETE",
    "StatusReason": "Resource ALIYUN::ECS::VPC vpc-m5eauuq80anx59v28**** could not be found for template scratch.",
    "FailedCode": "InvalidZoneId",
    "TemplateScratchData": {
      "test": "test",
      "test2": 1
    },
    "PreferenceParameters": [
      {
        "ParameterKey": "DeletionPolicy",
        "ParameterValue": "Retain"
      }
    ],
    "Description": "Copy VPC resources.",
    "SourceResources": [
      {
        "ResourceId": "vpc-m5e7cv7e9mz69sszb****",
        "ResourceType": "ALIYUN::ECS::VPC",
        "RelatedResourceTypeFilter": [
          "ALIYUN::ECS::VPC"
        ]
      }
    ],
    "SourceTag": {
      "ResourceTags": {
        "a": "b"
      },
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "SourceResourceGroup": {
      "ResourceGroupId": "rg-acfmzawhxxc****",
      "ResourceTypeFilter": [
        "ALIYUN::ECS::VPC"
      ]
    },
    "LogicalIdStrategy": "LongTypePrefixAndIndexSuffix",
    "CreateTime": "2021-12-22T01:49:22",
    "UpdateTime": "2021-12-22T01:49:23",
    "Stacks": [
      {
        "StackId": "3708bf6a-3a67-44d4-9eb1-c56704b9****",
        "RegionId": "cn-hangzhou",
        "UsageType": "ArchitectureReplication"
      }
    ],
    "StackProvision": {
      "Creatable": true,
      "Importable": false
    },
    "ResourceGroupId": "rg-acfmzmhzoaad5oq"
  }
}

錯誤碼

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

變更歷史

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