スクラッチ作成からシナリオを作成します。
操作説明
制限
特定のリソースタイプのみが、リソースシナリオ機能をサポートしています。 詳細については、「シナリオをサポートするリソースタイプ」をご参照ください。
説明
Resource Orchestration Service (ROS) は、リソースシナリオ機能を提供します。 UI でリソース範囲を選択し、リソースグループのレプリケーションや管理などの操作を実行することで、リソース管理を簡素化できます。 リソースシナリオの詳細については、「概要」をご参照ください。
リソース複製シナリオ
リソースのコレクションとリソース間の依存関係を複製する場合は、リソース複製シナリオを作成できます。 このタイプのシナリオでは、指定された範囲内のすべての既存リソースを複製し、既存リソースと同じアーキテクチャを持つリソースのコレクションを生成できます。 詳細については、「リソース複製シナリオ」をご参照ください。
リソース検出シナリオ
作成するリソース間の関係が複雑な場合は、リソース検出シナリオを作成して、リソース全体のアーキテクチャ、または特定のリソースから始まるアーキテクチャをプレビューできます。 これにより、リソース管理が簡素化されます。 詳細については、「リソース検出シナリオ」をご参照ください。
リソース管理シナリオ
既存のリソースのコレクションを新しいリソーススタックにインポートして一元管理する必要がある場合は、リソース管理シナリオを作成できます。 詳細については、「リソース管理シナリオ」をご参照ください。
リソース移行シナリオ
リソースのコレクションとリソース間の依存関係を移行する場合は、リソース移行シナリオを作成できます。 リソースを移行すると、ROS はスタックを生成します。 移行の進捗状況は、シナリオ詳細ページの [Stacks] タブで確認できます。 リソースの移行後、ソースリソースを削除できます。 詳細については、「リソース移行シナリオ」をご参照ください。
このトピックでは、China (Hangzhou) リージョンでリソース複製シナリオを作成し、ID vpc-bp1m6fww66xbntjyc**** の Virtual Private Cloud (VPC) を複製する例について説明します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ros:CreateTemplateScratch |
create |
*TemplateScratch
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リソースシナリオのリージョン ID です。 DescribeRegions API を呼び出して、最新のリージョンリストを照会できます。 |
cn-hangzhou |
| TemplateScratchType |
string |
必須 |
リソースシナリオのタイプです。有効な値:
説明
TemplateScratchType パラメーターに異なる値を指定すると、リクエストパラメーターの補足説明に記載されている任意パラメーターも異なります。詳細については、以下の「リクエストパラメーターの補足説明」をご参照ください。 |
ArchitectureReplication |
| Description |
string |
任意 |
リソースシナリオの説明です。 |
Copy VPC resources. |
| SourceResources |
array<object> |
任意 |
ソースリソースです。 TemplateScratchType を ArchitectureDetection に設定した場合、SourceResources を指定して、指定したソースリソースに関連付けられているすべてのリソースのアーキテクチャデータを検出できます。たとえば、CLB インスタンス ID を指定すると、システムは ECS インスタンス、vSwitch、VPC などの関連リソースを検出して識別します。 TemplateScratchType を ArchitectureDetection に設定した場合、最大 20 個のソースリソースを指定できます。 それ以外の場合は、最大 200 個のソースリソースを指定できます。 |
|
|
object |
任意 |
ソースリソースです。 |
||
| ResourceId |
string |
必須 |
リソース ID です。 |
vpc-bp1m6fww66xbntjyc**** |
| ResourceType |
string |
必須 |
リソースタイプです。 |
ALIYUN::ECS::VPC |
| RegionId |
string |
任意 |
リソースのリージョン ID です。 DescribeRegions API を呼び出して、最新のリージョンリストを照会できます。 説明
|
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> |
任意 |
リソースシナリオの設定パラメーターです。 |
|
|
object |
任意 |
|||
| ParameterKey |
string |
必須 |
パラメーターキーです。 有効な値の詳細については、このトピックの「リクエストパラメーターの補足説明」をご参照ください。 説明
|
DeletionPolicy |
| ParameterValue |
string |
必須 |
パラメーター値です。ParameterKey に割り当てる値です。 有効な値の詳細については、このトピックの「リクエストパラメーターの補足説明」をご参照ください。 説明
PreferenceParameters は任意です。PreferenceParameters を指定する場合は、ParameterKey と ParameterValue を指定する必要があります。 |
Retain |
| LogicalIdStrategy |
string |
任意 |
論理 ID の生成戦略です。有効な値:
説明
デフォルト値:LongTypePrefixAndIndexSuffix。TemplateScratchType を ArchitectureDetection に設定した場合のデフォルト値は LongTypePrefixAndHashSuffix です。 |
LongTypePrefixAndIndexSuffix |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用します。この値はクライアント側で生成する必要があり、グローバルに一意である必要があります。 長さは 64 文字以内で、文字、数字、ハイフン (-) 、アンダースコア (_) を使用できます。 詳細については、「How to ensure idempotence」をご参照ください。 |
123e4567-e89b-12d3-a456-42665544**** |
| ExecutionMode |
string |
任意 |
実行モードです。有効な値:
説明
リソースの範囲が大きい場合、同期実行には時間がかかります。タイムアウトを回避するため、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 | リソースのレプリケーション先 VPC の ID。同じリージョン内でリソースをレプリケートする場合、宛先 VPC を指定しないと、レプリケートされたリソースにはソースリソースの VPC が使用されます。リージョン間でリソースをレプリケートする場合、宛先 VPC を指定しないと、システムは自動的に宛先リージョンに VPC を作成します。例:vpc-bp1hye0s8b69xokfu****。 |
| VSwitchId | リソースのレプリケーション先 vSwitch の ID。同じリージョン内でリソースをレプリケートする場合、宛先 vSwitch を指定しないと、レプリケートされたリソースにはソースリソースの vSwitch が使用されます。リージョン間でリソースをレプリケートする場合、宛先 vSwitch を指定しないと、システムは自動的に宛先リージョンに vSwitch を作成します。例:vsw-bp11ufkwqwggtm1cj****。 |
| NamePrefix | リソース名のプレフィックス。デフォルトでは、リソース名にプレフィックスは含まれません。プレフィックスの長さは 2〜32 文字である必要があります。 |
| DisableNameUnique | 名前の一意性の自動適用を無効にするかどうかを指定します。デフォルトでは、名前の一意性は自動的に適用されます (パラメーター値は false)。Bucket リソースなど、この機能が有効になっているリソースの場合、8 文字のランダムなコードがリソース名に自動的に追加され、レプリケートされたリソースの名前の一意性が確保されます。 |
| InstanceDataReplication | ECS インスタンスのデータをレプリケートするかどうかを指定します。有効な値: true:ECS インスタンスのデータをレプリケートします。同じリージョン内でデータをレプリケートする場合、ソースインスタンスからカスタムイメージが作成され、そのカスタムイメージを基に新しいインスタンスが作成されます。リージョン間でデータをレプリケートする場合、ソースインスタンスからカスタムイメージが作成されて宛先リージョンにレプリケートされ、そのカスタムイメージを基に新しいインスタンスが作成されます。 false (デフォルト):ECS インスタンスのデータをレプリケートしません。 |
| InstancePeriod | 宛先となるサブスクリプションタイプの ECS インスタンスのサブスクリプション期間。デフォルトでは、ソースインスタンスのサブスクリプション期間が使用されます。 |
| InstancePeriodUnit | 宛先となるサブスクリプションタイプの ECS インスタンスのサブスクリプション期間の単位。デフォルトでは、ソースインスタンスのサブスクリプション期間の単位が使用されます。有効な値: * Week * Month * Year |
| InstanceAmount | レプリケートする ECS インスタンスの数。このパラメーターは、ソースリソースが単一の ECS インスタンスの場合にのみ有効です。 |
| RamAttachedPolicyReplication | RAM ユーザー、ユーザーグループ、およびロールに関連付けられた RAM ポリシーをレプリケートするかどうかを指定します。有効な値: * true * false (デフォルト) |
| AlbLoadBalancerEdition | ALB インスタンスのエディション。機能と課金ルールはエディションによって異なります。有効な値: * Basic:Basic Edition * Standard:Standard Edition * StandardWithWaf:Web Application Firewall (WAF) 対応エディション 例:Standard。 |
| AlbAddressType | ALB インスタンスのアドレスタイプ。有効な値: * Internet:ALB インスタンスはパブリック IP アドレスを持ちます。ドメインネームシステム (DNS) によってドメイン名はパブリック IP アドレスに解決されます。したがって、ALB インスタンスにはインターネット経由でアクセスできます。 * Intranet:ALB インスタンスはプライベート IP アドレスのみを持ちます。DNS ドメイン名はプライベート IP アドレスに解決されます。したがって、ALB インスタンスは、ALB インスタンスがデプロイされている VPC 内からのみアクセスできます。 例:Internet。 |
| AlbAddressIpVersion | IP バージョン。有効な値: * IPv4:IPv4 * DualStack:デュアルスタック 例:IPv4。 |
| AlbZoneMappings | ゾーンと vSwitch 間のマッピング。最大 10 個のゾーンを指定できます。選択したリージョンが 2 つ以上のゾーンをサポートしている場合は、サービスの高可用性を確保するために少なくとも 2 つのゾーンを選択してください。この値は、ALB の CreateLoadBalancer API の ZoneMappings パラメーターと同じ構造を持つ JSON 文字列です。例:[{"ZoneId": "cn-bejing-g", "VSwitchId": "vsw-gersdf****"}, {"ZoneId": "cn-bejing-f", "VSwitchId": "vsw-fersdf****"}] |
| SlbListenerProtocols | CLB インスタンスのリスナープロトコル。レプリケーションに含めるリスナープロトコルを指定します。複数のプロトコルをカンマで区切って設定できます。デフォルトでは、プロトコルは制限されません。有効な値: * tcp * udp * http * https 例:tcp,udp。 |
-
false: does not replicate ECS instance data. | | InstancePeriod | The subscription duration of the destination subscription ECS instance. By default, the subscription duration of the source instance is used. | | InstancePeriodUnit | The unit of the subscription duration of the destination subscription ECS instance. By default, the subscription duration unit of the source instance is used. Valid values:* Week
-
Month
-
Year | | InstanceAmount | The number of ECS instances to be replicated. This parameter takes effect only when the source resource is a single ECS instance. | | RamAttachedPolicyReplication | Specifies whether to replicate the RAM policy associated with RAM users, user groups, and roles. Default value: false. Valid values:* true
-
false | | AlbLoadBalancerEdition | The edition of the ALB instance. The features and billing rules vary based on the edition. Valid values:* Basic: Basic Edition
-
Standard: Standard Edition
-
StandardWithWaf: Web Application Firewall (WAF)-enabled EditionExample: Standard. | | AlbAddressType | The type of the address of the ALB instance. Valid values:* Internet: The ALB instance has a public IP address. The Domain Name System (DNS) domain name is resolved to the public IP address. Therefore, the ALB instance can be accessed over the Internet.
-
Intranet: The ALB instance has only a private IP address. The DNS domain name is resolved to the private IP address. Therefore, the ALB instance can be accessed only within the VPC where the ALB instance is deployed.Example: Internet. | | AlbAddressIpVersion | The IP version. Valid values:* IPv4: IPv4
-
DualStack: dual stackExample: IPv4. | | AlbZoneMappings | The mappings between zones and vSwitches. You can specify at most 10 zones. If the selected region supports two or more zones, select at least two zones to ensure the high availability of your service. The value is a JSON string that has the same structure as the
ZoneMappingsparameter in the ALB CreateLoadBalancer operation. Example: [{"ZoneId": "cn-bejing-g": "VSwitchId": "vsw-gersdf****"}, {"ZoneId": "cn-bejing-f": "VSwitchId": "vsw-fersdf****"}] | | SlbListenerProtocols | The listener protocol of a CLB instance. Specifies the listener protocols to be included in the replication. You can set one or more protocols, separated by commas. By default, no restriction is applied. Valid values:* tcp -
udp
-
http
-
httpsExample: tcp,udp. |
ParameterKey を InstanceDataReplication に、ParameterValue を true に設定する場合、データ整合性を確保するために、リソースをレプリケートする前にソースインスタンスを停止してください。
リソースプロファイリングシナリオ
次の表に、TemplateScratchType を ArchitectureDetection に設定した場合の ParameterKey と ParameterValue の有効な値を示します。
| ParameterKey | ParameterValue |
| RegionIds | 1 つ以上のリージョン ID。複数のリージョン ID はカンマ (,) で区切ります。グローバルリージョン global がサポートされています。リージョンを指定しない場合は、シナリオのリージョンが使用されます。 |
リソース管理シナリオ
次の表に、TemplateScratchType を ResourceImport に設定した場合の ParameterKey と ParameterValue の有効な値を示します。
リソース管理シナリオでは、ParameterKey を DeletionPolicy に設定する必要があります。
| ParameterKey | ParameterValue |
| DeletionPolicy | リソース削除ポリシー。有効な値: Retain:リソースの管理用スタックを削除する際にリソースを保持します。 Delete:リソースの管理用スタックを削除する際に、デフォルトでリソースを削除します。「スタックの削除」ダイアログボックスで特定のリソースを保持することを選択した場合、そのリソースは保持されます。 |
| SlbListenerProtocols | CLB インスタンスのリスナープロトコル。管理に含めるリスナープロトコルを指定します。複数のプロトコルをカンマで区切って設定できます。デフォルトでは、プロトコルは制限されません。有効な値: * tcp * udp * http * https 例:tcp,udp。 |
-
udp
-
http
-
httpsExample: tcp,udp. |
リソース移行シナリオ
次の表に、TemplateScratchType を ResourceMigration に設定した場合の ParameterKey と ParameterValue の有効な値を示します。
| ParameterKey | ParameterValue |
| RegionId | リソースの移行先リージョンの ID。宛先リージョンを指定しない場合、デフォルトで現在のリージョンが使用されます。例:cn-shanghai。 |
| ZoneId | リソースの移行先ゾーンの ID。同じリージョン内でリソースを移行する場合、宛先ゾーンを指定しないと、移行されたリソースにはソースリソースのゾーンが使用されます。リージョン間でリソースを移行する場合、宛先ゾーンを指定しないと、システムはすべてのリソースでサポートされているゾーンをフィルターします。例:cn-shanghai-b。 |
| VpcId | リソースの移行先 VPC の ID。同じリージョン内でリソースを移行する場合、宛先 VPC を指定しないと、移行されたリソースにはソースリソースの VPC が使用されます。リージョン間でリソースを移行する場合、宛先 VPC を指定しないと、システムは自動的に宛先リージョンに VPC を作成します。例:vpc-bp1hye0s8b69xokfu****。 |
| VSwitchId | リソースの移行先 vSwitch の ID。同じリージョン内でリソースを移行する場合、宛先 vSwitch を指定しないと、移行されたリソースにはソースリソースの vSwitch が使用されます。リージョン間でリソースを移行する場合、宛先 vSwitch を指定しないと、システムは自動的に宛先リージョンに vSwitch を作成します。例:vsw-bp11ufkwqwggtm1cj****。 |
| InstanceDataReplication | ECS インスタンスのデータを移行するかどうかを指定します。有効な値: true:ECS インスタンスのデータを移行します。同じリージョン内でデータを移行する場合、ソースインスタンスからカスタムイメージが作成され、そのカスタムイメージを基に新しいインスタンスが作成されます。リージョン間でデータを移行する場合、ソースインスタンスからカスタムイメージが作成されて宛先リージョンにレプリケートされ、そのカスタムイメージを基に新しいインスタンスが作成されます。 false:ECS インスタンスのデータを移行しません。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID です。 |
84980977-22F0-5421-B30D-B201311D5DCF |
| TemplateScratchId |
string |
リソースシナリオの ID です。 |
ts-7f7a704cf71c49a6**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "84980977-22F0-5421-B30D-B201311D5DCF",
"TemplateScratchId": "ts-7f7a704cf71c49a6****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。