調用CreateTemplateScratch介面建立資源情境-Resource Orchestration Service-阿里雲 - Resource Orchestration Service

建立資源情境。

介面說明

使用限制

僅部分資源類型支援資源情境功能。更多資訊，請參見支援資源情境的資源類型。

使用說明

通過資源情境功能，您可以在可視化介面上選擇資源範圍，並對一組資源進行複製、納管等操作，從而簡化資源管理。關於資源情境的更多資訊，請參見概覽。

資源複製情境

如果您需要複製一組資源及其依賴關係，可以通過建立資源複製情境複製指定範圍內的所有資源，產生一套架構完全相同的資源。更多資訊，請參見資源複製情境。

資源探查情境

如果您當前建立的資源之間關係錯綜複雜，您可以通過建立資源探查情境預覽整體資源架構，或者以特定資源為起點的資源架構，從而方便管理資源。更多資訊，請參見資源探查情境。

資源納管情境

如果您需要將一組現有資源匯入到一個新的資源棧中進行統一管理，可以建立資源納管類型的資源情境。更多資訊，請參見資源納管情境。

資源遷移情境

如果您需要遷移一組資源及其依賴關係，可以建立資源遷移類型的資源情境，在資源情境中遷移資源、產生資源棧，通過資源棧查看遷移進度，待遷移完成後，您還可以刪除源資源。更多資訊，請參見資源遷移情境。

本文將提供一個樣本，為您在杭州地區建立一個資源複製類型的資源情境，用於複製專用網路vpc-bp1m6fww66xbntjyc****。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ros:CreateTemplateScratch

create

*TemplateScratch

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	資源情境所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
TemplateScratchType	string	是	資源情境類型，取值： ArchitectureReplication：資源複製。 ArchitectureDetection：資源探查。 ResourceImport：資源納管。 ResourceMigration：資源遷移。說明當 TemplateScratchType 參數取值不同時，請求參數補充說明中可選的參數屬性也不同。更多資訊，請參見下方的請求參數補充說明。	ArchitectureReplication
Description	string	否	資源情境說明。	Copy VPC resources.
SourceResources	array<object>	否	源資源。如果 TemplateScratchType 為 ArchitectureDetection，設定本參數意味著探查出以指定的源資源為起點的所有資源的架構資料。例如，指定 CLB 執行個體 ID，會探查出其所關聯的 ECS 執行個體、vSwitch、VPC 等資源架構資料。最多支援設定 200 個源資源。如果 TemplateScratchType 為 ArchitectureDetection，最多設定 20 個源資源。
	object	否	源資源。
ResourceId	string	是	資源 ID。	vpc-bp1m6fww66xbntjyc****
ResourceType	string	是	資源類型。	ALIYUN::ECS::VPC
RegionId	string	否	資源所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。說明僅在 TemplateScratchType 為 ArchitectureDetection 時生效。全域資源的地區為`global`。例如，ALIYUN::CDN::Domain 是全域資源，資源所屬的地區 ID 為`global`。	cn-beijing
RelatedResourceTypeFilter	array	否	相關資源類型過濾列表。
	string	否	過濾資源類型。	ALIYUN::ECS::VPC
SourceTag	object	否	源標籤。
ResourceTags	object	是	源標籤，其中鍵為標籤鍵，值為標籤值。如果只希望指定標籤鍵，則值需設定為空白字串，例如：`{"TagKey": ""}`。最多支援設定 10 個源標籤。如果 TemplateScratchType 為 ArchitectureDetection，最多設定 5 個源標籤。	{"a": "b"}
ResourceTypeFilter	array	否	資源類型篩選器。
	string	否	資源類型篩選器。若指定了資源類型列表，則表示掃描指定資源類型且包含指定標籤的資源；反之，則表示掃描所有包含指定標籤的資源。最多支援 20 個資源類型。	ALIYUN::ECS::VPC
SourceResourceGroup	object	否	源資源群組。
ResourceGroupId	string	是	源資源群組 ID。	rg-acfmzawhxxc****
ResourceTypeFilter	array	否	資源類型篩選器。
	string	否	資源類型篩選器。若指定了資源類型列表，則表示掃描指定資源類型且在指定資源群組的資源；反之，則表示掃描所有在指定資源群組的資源。最多支援 20 個資源類型。	ALIYUN::ECS::VPC
PreferenceParameters	array<object>	否	資源情境配置參數。
	object	否
ParameterKey	string	是	參數名稱。關於取值的更多資訊，請參見下列的請求參數補充說明。說明 PreferenceParameters 為選擇性參數。如果需要指定 PreferenceParameters，則 ParameterKey 和 ParameterValue 必須同時指定。當 TemplateScratchType 取值為 ResourceImport 時，必須指定 ParameterKey 為 DeletionPolicy。	DeletionPolicy
ParameterValue	string	是	參數值。取值與 ParameterKey 對應。關於取值的更多資訊，請參見下列的請求參數補充說明。說明 PreferenceParameters 為選擇性參數。如果需要指定 PreferenceParameters，則 ParameterKey 和 ParameterValue 必須同時指定。	Retain
LogicalIdStrategy	string	否	邏輯 ID 建置原則，取值： LongTypePrefixAndIndexSuffix：長類型首碼+索引尾碼。 LongTypePrefixAndHashSuffix：長類型首碼+雜湊尾碼。 ShortTypePrefixAndHashSuffix：短類型首碼+雜湊尾碼。說明預設值為 LongTypePrefixAndIndexSuffix。如果 TemplateScratchType 為 ArchitectureDetection，預設值為 LongTypePrefixAndHashSuffix。	LongTypePrefixAndIndexSuffix
ClientToken	string	否	保證請求的等冪性。該值由用戶端產生，並且必須是全域唯一的。長度不超過 64 個字元，可包含英文字母、數字、短劃線（-）和底線（_）。更多資訊，請參見如何保證等冪性。	123e4567-e89b-12d3-a456-42665544****
ExecutionMode	string	否	執行模式，取值： Async（預設值）：非同步執行。 Sync：同步執行。說明如果資源範圍較大，同步執行的時間會比較長，推薦同時指定 ClientToken，以避免逾時問題。	Sync
Tags	array<object>	否	資源情境的標籤。
	object	否
Key	string	是	資源情境的標籤鍵。說明 Tags 為選擇性參數。如果需要指定 Tags，則 Tags.N.Key 必須指定。	usage
Value	string	否	資源情境的標籤值。	test
ResourceGroupId	string	否	資源群組 ID。如果不指定該參數，資源情境將加入預設資源群組。	rg-acfmxazb4ph6aiy****

請求參數補充說明

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

當TemplateScratchType參數的取值不同，下列對應支援的 ParameterKey、ParameterValue 也不同。

資源複製情境

當 TemplateScratchType 取值為 ArchitectureReplication 時，資源複製類型的資源情境支援的 ParameterKey、ParameterValue 如下：

ParameterKey	ParameterValue
DeletionPolicy	資源刪除策略，取值： Retain：保留。將資源複製到資源棧後，在刪除此資源棧時，保留原有資源。 Delete：刪除。將資源複製到資源棧後，在刪除此資源棧時，預設刪除原有資源；若在刪除確認框中選擇保留部分資源，則刪除未選擇保留的資源。
RegionId	希望複製到的目標地區 ID。若不指定，預設為當前地區。樣本：cn-shanghai。
ZoneId	希望複製到的目標可用性區域 ID。若不指定，當同地區複製時，複製出的資源和源資源可用性區域保持一致；當跨地區複製時，會篩選出所有資源均支援的可用性區域。樣本：cn-shanghai-b。
VpcId	希望複製到的目標專用網路 ID。若不指定，當同地區複製時，複製出的資源和源資源專用網路保持一致；當跨地區複製時，會在目標地區自動建立專用網路。樣本：vpc-bp1hye0s8b69xokfu****。
VSwitchId	希望複製到的目標交換器 ID。若不指定，當同地區複製時，複製出的資源和源資源交換器保持一致；當跨地區複製時，會在目標地區自動建立交換器。樣本：vsw-bp11ufkwqwggtm1cj****。
NamePrefix	資源名稱首碼，預設無首碼。長度 2-32 個字元。
DisableNameUnique	是否禁用名稱自動唯一。預設不禁用，會針對名稱唯一性的資源（如 Bucket）自動添加 8 位隨機碼確保複製出的資源的名稱唯一性。
InstanceDataReplication	是否複製 ECS 執行個體資料，預設 false。取值： true：複製 ECS 執行個體資料。當同地區複製時，會為源執行個體構建自訂鏡像，以此鏡像建立新執行個體；當跨地區複製時，會為源執行個體構建自訂鏡像，並拷貝至目標地區，以新鏡像建立新執行個體。 false：不複製 ECS 執行個體資料。
InstancePeriod	希望複製的 ECS 預付費執行個體的付費時間長度，預設同源執行個體。
InstancePeriodUnit	希望複製的 ECS 預付費執行個體的付費周期，預設同源執行個體。取值： Week：周。 Month：月。 Year：年。
InstanceAmount	希望複製的 ECS 執行個體數量，僅在源資源為單個 ECS 執行個體時生效。
RamAttachedPolicyReplication	是否複製關聯的 RAM 策略，預設 false。取值： true：true：複製 RAM 使用者、角色、組所關聯的策略。 false：不複製關聯的 RAM 策略。
AlbLoadBalancerEdition	應用型負載平衡的版本，不同版本有不同功能限制和計費策略。取值： Basic：基礎版。 Standard：標準版。 StandardWithWaf：WAF 增強版。樣本：Standard。
AlbAddressType	應用型負載平衡的地址類型。取值： Internet：負載平衡具有公網 IP 位址，DNS 網域名稱被解析到公網 IP，因此可以在公網環境訪問。 Intranet：負載平衡只有私網 IP 位址，DNS 網域名稱被解析到私網 IP，因此只能被負載平衡所在 VPC 的內網環境訪問。樣本：Internet。
AlbAddressIpVersion	協議版本。取值： IPv4：IPv4 類型。 DualStack：雙棧類型。樣本：IPv4。
AlbZoneMappings	可用性區域及交換器映射列表，最多支援添加 10 個可用性區域。若當前地區支援 2 個及以上的可用性區域，至少需要添加 2 個可用性區域。類型為 Json 字串，結構同 ALB CreateLoadBalancer 的 `ZoneMappings` 參數。樣本：[{"ZoneId": "cn-bejing-g": "VSwitchId": "vsw-gersdf**"}, {"ZoneId": "cn-bejing-f": "VSwitchId": "vsw-fersdf**"}]
SlbListenerProtocols	傳統型Server Load Balancer執行個體監聽協議，用來限定複製的監聽協議，可設定一個或多個，使用英文逗號分隔，預設為不限定。取值： tcp udp http https 樣本：tcp,udp。

說明

當您指定 ParameterKey 為 InstanceDataReplication、ParameterValue 為 true 時，為了確保資料一致性，請您停止源執行個體後再複製資源。

資源探查情境

當 ArchitectureReplication 參數取值為 ArchitectureDetection 時，資源探查類型的資源情境支援的 ParameterKey、ParameterValue 如下：

ParameterKey	ParameterValue
RegionIds	一個或多個地區，使用","分隔。支援全域地區`global`。如果不指定，則為當前資源情境的地區。

資源納管情境

當 ArchitectureDetection 參數取值為 ResourceImport 時，資源納管類型的資源情境支援的 ParameterKey、ParameterValue 如下：

說明

資源納管類型的資源情境，必須指定 ParameterKey 為 DeletionPolicy。

ParameterKey	ParameterValue
DeletionPolicy	資源刪除策略，取值： Retain：保留。將資源納管至資源棧後，在刪除此資源棧時，保留原有資源。 Delete：刪除。將資源納管至資源棧後，在刪除此資源棧時，預設刪除原有資源；若在刪除確認框中選擇保留部分資源，則刪除未選擇保留的資源。
SlbListenerProtocols	傳統型Server Load Balancer執行個體監聽協議，用來限定納管的監聽協議，可設定一個或多個，使用英文逗號分隔，預設為不限定。取值： tcp udp http https 樣本：tcp,udp。

資源遷移情境

當 ArchitectureDetection 參數的取值為 ResourceMigration 時，資源遷移類型的資源情境支援的 ParameterKey、ParameterValue 如下：

ParameterKey	ParameterValue
RegionId	希望遷移到的目標地區 ID。若不指定，預設為當前地區。樣本：cn-shanghai。
ZoneId	希望遷移到的目標可用性區域 ID。若不指定，當同地區複製時，複製出的資源和源資源可用性區域保持一致；當跨地區複製時，會篩選出所有資源均支援的可用性區域。樣本：cn-shanghai-b。
VpcId	希望遷移到的目標專用網路 ID。若不指定，當同地區複製時，複製出的資源和源資源專用網路保持一致；當跨地區複製時，會在目標地區自動建立專用網路。樣本：vpc-bp1hye0s8b69xokfu****。
VSwitchId	希望遷移到的目標交換器 ID。若不指定，當同地區複製時，複製出的資源和源資源交換器保持一致；當跨地區複製時，會在目標地區自動建立交換器。樣本：vsw-bp11ufkwqwggtm1cj****。
InstanceDataReplication	是否遷移 ECS 執行個體資料，取值： true：遷移 ECS 執行個體資料。當同地區遷移時，會為源執行個體構建自訂鏡像，以此鏡像建立新執行個體；當跨地區複製時，會為源執行個體構建自訂鏡像，並拷貝至目標地區，以新鏡像建立新執行個體。 false：不遷移 ECS 執行個體資料。

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	84980977-22F0-5421-B30D-B201311D5DCF
TemplateScratchId	string	資源情境 ID。	ts-7f7a704cf71c49a6****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "84980977-22F0-5421-B30D-B201311D5DCF",
  "TemplateScratchId": "ts-7f7a704cf71c49a6****"
}

錯誤碼

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

變更歷史

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