更新資源場(chǎng)景。
接口說明
資源復(fù)制場(chǎng)景
您可以對(duì)資源場(chǎng)景內(nèi)容進(jìn)行修改，且修改后的內(nèi)容不會(huì)對(duì)之前復(fù)制生成的資源棧產(chǎn)生影響。 您還可以調(diào)用GenerateTemplateByScratch - 為資源場(chǎng)景生成模板接口為資源場(chǎng)景生成模板。
資源遷移場(chǎng)景
- 當(dāng)您僅遷移資源并未刪除源資源時(shí)，如果您對(duì)資源場(chǎng)景進(jìn)行更新，您可以通過刪除源資源操作納管更新后的資源場(chǎng)景內(nèi)容。您還可以調(diào)用GenerateTemplateByScratch - 為資源場(chǎng)景生成模板接口為資源場(chǎng)景生成新的模板。
說明 請(qǐng)確保待刪除的源資源不存在除資源場(chǎng)景外的資源關(guān)系，否則刪除不成功。
- 當(dāng)您在遷移資源后并選擇刪除源資源時(shí)，如果您對(duì)資源場(chǎng)景進(jìn)行更新，您僅可以調(diào)用 GenerateTemplateByScratch 為資源場(chǎng)景生成模板接口為資源場(chǎng)景生成新的模板。
資源納管場(chǎng)景
當(dāng)您在納管資源后更新資源場(chǎng)景內(nèi)容，您僅可以調(diào)用GenerateTemplateByScratch - 為資源場(chǎng)景生成模板接口為資源場(chǎng)景生成新的模板。
資源探查場(chǎng)景
當(dāng)您更新資源探查場(chǎng)景內(nèi)容后，ROS 會(huì)從資源中心獲取最新的數(shù)據(jù)并渲染出架構(gòu)圖。
本文將提供一個(gè)示例，將杭州地域的資源場(chǎng)景ts-7f7a704cf71c49a6****中的 VPC 資源 ID 更新為vpc-bp1m6fww66xbntjyc****。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ros:UpdateTemplateScratch | update |
|
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 資源場(chǎng)景所屬的地域 ID。 您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| TemplateScratchId | string | 是 | 資源場(chǎng)景 ID。 當(dāng)您輸入的資源場(chǎng)景 ID 為不同的場(chǎng)景類型時(shí)，可選的請(qǐng)求參數(shù)屬性也不同。更多信息，請(qǐng)參見下列的請(qǐng)求參數(shù)補(bǔ)充說明。 說明
您可以調(diào)用ListTemplateScratches - 查詢資源場(chǎng)景列表查看資源場(chǎng)景 ID。
| ts-7f7a704cf71c49a6**** |
| Description | string | 否 | 資源場(chǎng)景說明。 | 復(fù)制VPC資源。 |
| SourceResources | array<object> | 否 | 源資源。 說明
SourceResources、SourceTag 和 SourceResourceGroup 參數(shù)僅需設(shè)置其中一個(gè)。
| |
| object | 否 | 源資源。 如果 TemplateScratchType 為 ArchitectureDetection，設(shè)置本參數(shù)意味著探查出以指定的源資源為起點(diǎn)的所有資源的架構(gòu)數(shù)據(jù)。例如，指定 CLB 實(shí)例 ID，會(huì)探查出其所關(guān)聯(lián)的 ECS 實(shí)例、vSwitch、VPC 等資源架構(gòu)數(shù)據(jù)。 最多支持設(shè)置 200 個(gè)源資源。如果 TemplateScratchType 為 ArchitectureDetection，最多設(shè)置 20 個(gè)源資源。 | ||
| ResourceId | string | 是 | 資源 ID。 | vpc-bp1m6fww66xbntjyc**** |
| ResourceType | string | 是 | 資源類型。 | ALIYUN::ECS::VPC |
| SourceTag | object | 否 | 源標(biāo)簽。 說明
SourceResources、SourceTag 和 SourceResourceGroup 參數(shù)僅需設(shè)置其中一個(gè)。
| |
| ResourceTags | object | 是 | 源標(biāo)簽，其中鍵為標(biāo)簽鍵，值為標(biāo)簽值。 如果只希望指定標(biāo)簽鍵，則值需設(shè)置為空字符串，例如：{"TagKey": ""}。 最多支持設(shè)置 10 個(gè)源標(biāo)簽。如果 TemplateScratchType 為 ArchitectureDetection，最多設(shè)置 5 個(gè)源標(biāo)簽。 | {"a": "b"} |
| ResourceTypeFilter | array | 否 | 資源類型篩選器。 | |
| string | 否 | 資源類型篩選器。若指定了資源類型列表，則表示掃描指定資源類型且包含指定標(biāo)簽的資源；反之，則表示掃描所有包含指定標(biāo)簽的資源。 最多支持 20 個(gè)資源類型。 | ALIYUN::ECS::VPC | |
| SourceResourceGroup | object | 否 | 源資源組。 說明
SourceResources、SourceTag 和 SourceResourceGroup 參數(shù)僅需設(shè)置其中一個(gè)。
| |
| ResourceGroupId | string | 是 | 源資源組 ID。 | rg-acfmzawhxxc**** |
| ResourceTypeFilter | array | 否 | 資源類型篩選器。 | |
| string | 否 | 資源類型篩選器。若指定了資源類型列表，則表示掃描指定資源類型且在指定資源組中的資源；反之，則表示掃描所有在指定資源組中的資源。 最多支持 20 個(gè)資源類型。 | ALIYUN::ECS::VPC | |
| PreferenceParameters | array<object> | 否 | 資源場(chǎng)景配置參數(shù)。 | |
| object | 否 | 資源場(chǎng)景配置參數(shù)。 | ||
| ParameterKey | string | 是 | 參數(shù)名稱。 關(guān)于取值的更多信息，請(qǐng)參見請(qǐng)求參數(shù)補(bǔ)充說明。 說明
| DeletionPolicy |
| ParameterValue | string | 是 | 參數(shù)值。取值與 ParameterKey 對(duì)應(yīng)。 關(guān)于取值的更多信息，請(qǐng)參見請(qǐng)求參數(shù)補(bǔ)充說明。 說明
PreferenceParameters 為可選參數(shù)。如果需要指定 PreferenceParameters，則 ParameterKey 和 ParameterValue 必須同時(shí)指定。
| Retain |
| LogicalIdStrategy | string | 否 | 邏輯 ID 生成策略，取值：
說明
默認(rèn)值為 LongTypePrefixAndIndexSuffix。如果 TemplateScratchType 為 ArchitectureDetection，默認(rèn)值為 LongTypePrefixAndHashSuffix。
| LongTypePrefixAndIndexSuffix |
| ClientToken | string | 否 | 保證請(qǐng)求的冪等性。該值由客戶端生成，并且必須是全局唯一的。長(zhǎng)度不超過 64 個(gè)字符，可包含英文字母、數(shù)字、短劃線（-）和下劃線（_）。 更多信息，請(qǐng)參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-42665544**** |
| ExecutionMode | string | 否 | 執(zhí)行模式，取值：
說明
如果資源范圍較大，同步執(zhí)行的時(shí)間會(huì)比較長(zhǎng)，推薦同時(shí)指定 ClientToken，以避免超時(shí)問題。
| Sync |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmxazb4ph6aiy**** |
請(qǐng)求參數(shù)補(bǔ)充說明
關(guān)于公共請(qǐng)求參數(shù)的詳情，請(qǐng)參見公共參數(shù)。
請(qǐng)求參數(shù)中，不同類型的資源場(chǎng)景支持的 ParameterKey、ParameterValue 不同。
資源復(fù)制場(chǎng)景
當(dāng) TemplateScratchId 參數(shù)取值為資源復(fù)制場(chǎng)景 ID，支持的 ParameterKey、ParameterValue 如下：
| ParameterKey | ParameterValue |
|---|---|
| DeletionPolicy | 資源刪除策略，取值： Retain：保留。將資源復(fù)制到資源棧后，在刪除此資源棧時(shí)，保留原有資源。 Delete：刪除。將資源復(fù)制到資源棧后，在刪除此資源棧時(shí)，默認(rèn)刪除原有資源；若在刪除確認(rèn)框中選擇保留部分資源，則刪除未選擇保留的資源。 |
| RegionId | 希望復(fù)制到的目標(biāo)地域。若不指定，默認(rèn)為當(dāng)前地域。 示例：cn-shanghai。 |
| ZoneId | 希望復(fù)制到的目標(biāo)可用區(qū)。若不指定，當(dāng)同地域復(fù)制時(shí)，復(fù)制出的資源和源資源可用區(qū)保持一致；當(dāng)跨地域復(fù)制時(shí)，會(huì)篩選出所有資源均支持的可用區(qū)。 示例：cn-shanghai-b。 |
| VpcId | 希望復(fù)制到的目標(biāo)專有網(wǎng)絡(luò)。若不指定，當(dāng)同地域復(fù)制時(shí)，復(fù)制出的資源和源資源專有網(wǎng)絡(luò)保持一致；當(dāng)跨地域復(fù)制時(shí)，會(huì)在目標(biāo)地域自動(dòng)創(chuàng)建專有網(wǎng)絡(luò)。 示例：vpc-bp1hye0s8b69xokfu****。 |
| VSwitchId | 希望復(fù)制到的目標(biāo)交換機(jī)。若不指定，當(dāng)同地域復(fù)制時(shí)，復(fù)制出的資源和源資源交換機(jī)保持一致；當(dāng)跨地域復(fù)制時(shí)，會(huì)在目標(biāo)地域自動(dòng)創(chuàng)建交換機(jī)。 示例：vsw-bp11ufkwqwggtm1cj****。 |
| InstanceDataReplication | 是否復(fù)制 ECS 實(shí)例數(shù)據(jù)，取值： true：復(fù)制 ECS 實(shí)例數(shù)據(jù)。當(dāng)同地域復(fù)制時(shí)，會(huì)為源實(shí)例構(gòu)建自定義鏡像，以此鏡像創(chuàng)建新實(shí)例；當(dāng)跨地域復(fù)制時(shí)，會(huì)為源實(shí)例構(gòu)建自定義鏡像，并拷貝至目標(biāo)地域，以新鏡像創(chuàng)建新實(shí)例。 false：不復(fù)制 ECS 實(shí)例數(shù)據(jù)。 |
資源納管場(chǎng)景
當(dāng) TemplateScratchId 參數(shù)取值為資源納管場(chǎng)景 ID，支持的 ParameterKey、ParameterValue 如下：
| ParameterKey | ParameterValue |
|---|---|
| DeletionPolicy | 資源刪除策略，取值： Retain：保留。將資源納管至資源棧后，在刪除此資源棧時(shí)，保留原有資源。 Delete：刪除。將資源納管至資源棧后，在刪除此資源棧時(shí)，默認(rèn)刪除原有資源；若在刪除確認(rèn)框中選擇保留部分資源，則刪除未選擇保留的資源。 |
資源探查場(chǎng)景
當(dāng) TemplateScratchId 參數(shù)取值為資源探查場(chǎng)景 ID，支持的 ParameterKey、ParameterValue 如下：
| ParameterKey | ParameterValue |
|---|---|
| RegionIds | 一個(gè)或多個(gè)地域，使用","分隔。如果不指定，則為當(dāng)前資源場(chǎng)景的地域。不允許同時(shí)指定本參數(shù)和 SourceResources。 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "221DA822-B8CF-50DF-A9D2-BA197BF97BD5",
"TemplateScratchId": "ts-7f7a704cf71c49a6****"
}錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-10-10 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |