創(chuàng)建資源場景。
接口說明
使用限制
僅部分資源類型支持資源場景功能。更多信息,請參見支持資源場景的資源類型。
使用說明
通過資源場景功能,您可以在可視化界面上選擇資源范圍,并對一組資源進行復制、納管等操作,從而簡化資源管理。關于資源場景的更多信息,請參見概覽。
資源復制場景
如果您需要復制一組資源及其依賴關系,可以通過創(chuàng)建資源復制場景復制指定范圍內(nèi)的所有資源,生成一套架構完全相同的資源。更多信息,請參見資源復制場景。
資源探查場景
如果您當前創(chuàng)建的資源之間關系錯綜復雜,您可以通過創(chuàng)建資源探查場景預覽整體資源架構,或者以特定資源為起點的資源架構,從而方便管理資源。更多信息,請參見資源探查場景。
資源納管場景
如果您需要將一組現(xiàn)有資源導入到一個新的資源棧中進行統(tǒng)一管理,可以創(chuàng)建資源納管類型的資源場景。更多信息,請參見資源納管場景。
資源遷移場景
如果您需要遷移一組資源及其依賴關系,可以創(chuàng)建資源遷移類型的資源場景,在資源場景中遷移資源、生成資源棧,通過資源棧查看遷移進度,待遷移完成后,您還可以刪除源資源。更多信息,請參見資源遷移場景。
本文將提供一個示例,為您在杭州地域創(chuàng)建一個資源復制類型的資源場景,用于復制專有網(wǎng)絡vpc-bp1m6fww66xbntjyc****
。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
ros:CreateTemplateScratch | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 資源場景所屬的地域 ID。 您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
TemplateScratchType | string | 是 | 資源場景類型,取值:
說明
當 TemplateScratchType 參數(shù)取值不同時,請求參數(shù)補充說明中可選的參數(shù)屬性也不同。 更多信息,請參見下方的請求參數(shù)補充說明。
| ArchitectureReplication |
Description | string | 否 | 資源場景說明。 | 復制VPC資源。 |
SourceResources | array<object> | 否 | 源資源。 如果 TemplateScratchType 為 ArchitectureDetection,設置本參數(shù)意味著探查出以指定的源資源為起點的所有資源的架構數(shù)據(jù)。例如,指定 CLB 實例 ID,會探查出其所關聯(lián)的 ECS 實例、vSwitch、VPC 等資源架構數(shù)據(jù)。 最多支持設置 200 個源資源。如果 TemplateScratchType 為 ArchitectureDetection,最多設置 20 個源資源。 | |
object | 否 | 源資源。 | ||
ResourceId | string | 是 | 資源 ID。 | vpc-bp1m6fww66xbntjyc**** |
ResourceType | string | 是 | 資源類型。 | ALIYUN::ECS::VPC |
RegionId | string | 否 | 資源所屬的地域 ID。 您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 說明
global 。例如,ALIYUN::CDN::Domain 是全局資源,資源所屬的地域 ID 為global 。 | cn-beijing |
RelatedResourceTypeFilter | array | 否 | 相關資源類型過濾列表。 | |
string | 否 | 過濾資源類型。 | ALIYUN::ECS::VPC | |
SourceTag | object | 否 | 源標簽。 | |
ResourceTags | object | 是 | 源標簽,其中鍵為標簽鍵,值為標簽值。
如果只希望指定標簽鍵,則值需設置為空字符串,例如: 最多支持設置 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> | 否 | 資源場景配置參數(shù)。 | |
object | 否 | |||
ParameterKey | string | 是 | 參數(shù)名稱。 關于取值的更多信息,請參見下列的請求參數(shù)補充說明。 說明
| DeletionPolicy |
ParameterValue | string | 是 | 參數(shù)值。取值與 ParameterKey 對應。 關于取值的更多信息,請參見下列的請求參數(shù)補充說明。 說明
PreferenceParameters 為可選參數(shù)。如果需要指定 PreferenceParameters,則 ParameterKey 和 ParameterValue 必須同時指定。
| Retain |
LogicalIdStrategy | string | 否 | 邏輯 ID 生成策略,取值:
說明
默認值為 LongTypePrefixAndIndexSuffix。如果 TemplateScratchType 為 ArchitectureDetection,默認值為 LongTypePrefixAndHashSuffix。
| LongTypePrefixAndIndexSuffix |
ClientToken | string | 否 | 保證請求的冪等性。該值由客戶端生成,并且必須是全局唯一的。長度不超過 64 個字符,可包含英文字母、數(shù)字、短劃線(-)和下劃線(_)。 更多信息,請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-42665544**** |
ExecutionMode | string | 否 | 執(zhí)行模式,取值:
說明
如果資源范圍較大,同步執(zhí)行的時間會比較長,推薦同時指定 ClientToken,以避免超時問題。
| Sync |
Tags | array<object> | 否 | 資源場景的標簽。 | |
object | 否 | |||
Key | string | 是 | 資源場景的標簽鍵。 說明
Tags 為可選參數(shù)。如果需要指定 Tags,則 Tags.N.Key 必須指定。
| usage |
Value | string | 否 | 資源場景的標簽值。 | test |
ResourceGroupId | string | 否 | 資源組 ID。如果不指定該參數(shù),資源場景將加入默認資源組。 | rg-acfmxazb4ph6aiy**** |
請求參數(shù)補充說明
關于公共請求參數(shù)的詳情,請參見公共參數(shù)。
當TemplateScratchType
參數(shù)的取值不同,下列對應支持的 ParameterKey、ParameterValue 也不同。
資源復制場景
當 TemplateScratchType 取值為 ArchitectureReplication 時,資源復制類型的資源場景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
---|---|
DeletionPolicy | 資源刪除策略,取值: Retain:保留。將資源復制到資源棧后,在刪除此資源棧時,保留原有資源。 Delete:刪除。將資源復制到資源棧后,在刪除此資源棧時,默認刪除原有資源;若在刪除確認框中選擇保留部分資源,則刪除未選擇保留的資源。 |
RegionId | 希望復制到的目標地域 ID。若不指定,默認為當前地域。 示例:cn-shanghai。 |
ZoneId | 希望復制到的目標可用區(qū) ID。若不指定,當同地域復制時,復制出的資源和源資源可用區(qū)保持一致;當跨地域復制時,會篩選出所有資源均支持的可用區(qū)。 示例:cn-shanghai-b。 |
VpcId | 希望復制到的目標專有網(wǎng)絡 ID。若不指定,當同地域復制時,復制出的資源和源資源專有網(wǎng)絡保持一致;當跨地域復制時,會在目標地域自動創(chuàng)建專有網(wǎng)絡。 示例:vpc-bp1hye0s8b69xokfu****。 |
VSwitchId | 希望復制到的目標交換機 ID。若不指定,當同地域復制時,復制出的資源和源資源交換機保持一致;當跨地域復制時,會在目標地域自動創(chuàng)建交換機。 示例:vsw-bp11ufkwqwggtm1cj****。 |
NamePrefix | 資源名稱前綴,默認無前綴。長度 2-32 個字符。 |
DisableNameUnique | 是否禁用名稱自動唯一。默認不禁用,會針對名稱唯一性的資源(如 Bucket)自動添加 8 位隨機碼確保復制出的資源的名稱唯一性。 |
InstanceDataReplication | 是否復制 ECS 實例數(shù)據(jù),默認 false。取值:
|
InstancePeriod | 希望復制的 ECS 預付費實例的付費時長,默認同源實例。 |
InstancePeriodUnit | 希望復制的 ECS 預付費實例的付費周期,默認同源實例。取值:
|
InstanceAmount | 希望復制的 ECS 實例數(shù)量,僅在源資源為單個 ECS 實例時生效。 |
RamAttachedPolicyReplication | 是否復制關聯(lián)的 RAM 策略,默認 false。取值:
|
SlbListenerProtocols | 傳統(tǒng)型負載均衡實例監(jiān)聽協(xié)議,用來限定復制的監(jiān)聽協(xié)議,可設置一個或多個,使用英文逗號分隔,默認為不限定。取值:
|
資源探查場景
當 ArchitectureReplication 參數(shù)取值為 ArchitectureDetection 時,資源探查類型的資源場景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
---|---|
RegionIds | 一個或多個地域,使用","分隔。支持全局地域global 。如果不指定,則為當前資源場景的地域。 |
資源納管場景
當 ArchitectureDetection 參數(shù)取值為 ResourceImport 時,資源納管類型的資源場景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
---|---|
DeletionPolicy | 資源刪除策略,取值: Retain:保留。將資源納管至資源棧后,在刪除此資源棧時,保留原有資源。 Delete:刪除。將資源納管至資源棧后,在刪除此資源棧時,默認刪除原有資源;若在刪除確認框中選擇保留部分資源,則刪除未選擇保留的資源。 |
SlbListenerProtocols | 傳統(tǒng)型負載均衡實例監(jiān)聽協(xié)議,用來限定納管的監(jiān)聽協(xié)議,可設置一個或多個,使用英文逗號分隔,默認為不限定。取值:
|
資源遷移場景
當 ArchitectureDetection 參數(shù)的取值為 ResourceMigration 時,資源遷移類型的資源場景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
---|---|
RegionId | 希望復制到的目標地域 ID。若不指定,默認為當前地域。 示例:cn-shanghai。 |
ZoneId | 希望復制到的目標可用區(qū) ID。若不指定,當同地域復制時,復制出的資源和源資源可用區(qū)保持一致;當跨地域復制時,會篩選出所有資源均支持的可用區(qū)。 示例:cn-shanghai-b。 |
VpcId | 希望復制到的目標專有網(wǎng)絡 ID。若不指定,當同地域復制時,復制出的資源和源資源專有網(wǎng)絡保持一致;當跨地域復制時,會在目標地域自動創(chuàng)建專有網(wǎng)絡。 示例:vpc-bp1hye0s8b69xokfu****。 |
VSwitchId | 希望復制到的目標交換機 ID。若不指定,當同地域復制時,復制出的資源和源資源交換機保持一致;當跨地域復制時,會在目標地域自動創(chuàng)建交換機。 示例:vsw-bp11ufkwqwggtm1cj****。 |
InstanceDataReplication | 是否復制 ECS 實例數(shù)據(jù),取值: true:復制 ECS 實例數(shù)據(jù)。當同地域復制時,會為源實例構建自定義鏡像,以此鏡像創(chuàng)建新實例;當跨地域復制時,會為源實例構建自定義鏡像,并拷貝至目標地域,以新鏡像創(chuàng)建新實例。 false:不復制 ECS 實例數(shù)據(jù)。 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "84980977-22F0-5421-B30D-B201311D5DCF",
"TemplateScratchId": "ts-7f7a704cf71c49a6****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-04-24 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2023-10-19 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2023-10-10 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |