シナリオを更新します。
操作説明
リソース複製シナリオ
Resource Orchestration Service (ROS) では、リソース複製シナリオを更新できます。リソース複製シナリオを更新しても、そのリソースシナリオを使用して生成されたスタックには影響しません。 GenerateTemplateByScratch API を呼び出して、リソースシナリオのテンプレートを生成できます。
リソース移行シナリオ
-
移行元のソースリソースが保持されているリソース移行シナリオを更新する場合、ソースリソースを削除して、更新されたリソース移行シナリオを管理できます。また、GenerateTemplateByScratch API を呼び出して、リソースシナリオのテンプレートを生成することもできます。
注意:リソース移行シナリオから削除するソースリソースが、そのリソースシナリオのみに関連付けられていることを確認してください。それ以外の場合、ソースリソースの削除に失敗します。
注 リソース移行シナリオから削除するソースリソースが、そのリソースシナリオにのみ関連付けられていることを確認してください。そうでない場合、ソースリソースの削除に失敗します。
-
移行元のソースリソースが削除されているリソース移行シナリオを更新する場合、GenerateTemplateByScratch API を呼び出して、リソースシナリオのテンプレートを生成することしかできません。
リソース管理シナリオ
リソース管理シナリオを使用してリソースを管理した後にそのシナリオを更新する場合、GenerateTemplateByScratch API を呼び出して、リソースシナリオのテンプレートを生成することしかできません。
リソース検出シナリオ
リソース検出シナリオを更新すると、ROS はリソースセンターから最新のデータを取得し、アーキテクチャ図をレンダリングします。
このトピックでは、リソースシナリオを更新する方法の例を示します。この例では、ID が ts-7f7a704cf71c49a6**** のリソースシナリオ内の Virtual Private Cloud (VPC) の ID を vpc-bp1m6fww66xbntjyc**** に更新します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ros:UpdateTemplateScratch |
update |
*TemplateScratch
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リソースシナリオのリージョン ID です。 DescribeRegions API を呼び出して、最新のリージョンリストを照会できます。 |
cn-hangzhou |
| TemplateScratchId |
string |
必須 |
リソースシナリオの ID です。 リクエストパラメーター ParameterKey と ParameterValue の有効な値は、リソースシナリオのタイプごとに異なります。詳細については、このトピックの「追加のリクエストパラメーター情報」セクションをご参照ください。 説明
ListTemplateScratches API を呼び出して、リソースシナリオの ID を照会できます。 |
ts-7f7a704cf71c49a6**** |
| Description |
string |
任意 |
リソースシナリオの説明です。 |
Copy VPC resources. |
| SourceResources |
array<object> |
任意 |
ソースリソースです。 説明
次のパラメーターのうち、指定できるのはいずれか 1 つのみです:SourceResources、SourceTag、SourceResourceGroup。 |
|
|
object |
任意 |
ソースリソースです。 |
||
| ResourceId |
string |
必須 |
リソース ID です。 |
vpc-bp1m6fww66xbntjyc**** |
| ResourceType |
string |
必須 |
リソースタイプです。 |
ALIYUN::ECS::VPC |
| SourceTag |
object |
任意 |
ソースタグです。 説明
次のパラメーターのうち、指定できるのはいずれか 1 つのみです:SourceResources、SourceTag、SourceResourceGroup。 |
|
| ResourceTags |
object |
必須 |
ソースタグです。タグには、タグキーとタグ値が含まれます。 タグキーのみを指定する場合は、タグ値を空にする必要があります。例:{"TagKey": ""}。 TemplateScratchType を ArchitectureDetection に設定した場合、ソースタグは最大 5 個まで追加できます。それ以外の場合は、ソースタグは最大 10 個まで追加できます。 |
{"a": "b"} |
| ResourceTypeFilter |
array |
任意 |
リソースをフィルタリングするためのリソースタイプです。 |
|
|
string |
任意 |
リソースをフィルタリングするためのリソースタイプです。リソースタイプを指定すると、ROS は指定したリソースタイプで、かつ指定したタグを持つリソースのみをスキャンします。リソースタイプを指定しない場合、ROS は指定したタグを持つすべてのリソースをスキャンします。 指定できるリソースタイプは最大 20 個です。 |
ALIYUN::ECS::VPC |
|
| SourceResourceGroup |
object |
任意 |
ソースリソースグループです。 説明
次のパラメーターのうち、指定できるのはいずれか 1 つのみです:SourceResources、SourceTag、SourceResourceGroup。 |
|
| ResourceGroupId |
string |
必須 |
ソースリソースグループの ID です。 |
rg-acfmzawhxxc**** |
| ResourceTypeFilter |
array |
任意 |
リソースをフィルタリングするためのリソースタイプです。 |
|
|
string |
任意 |
リソースをフィルタリングするためのリソースタイプです。リソースタイプを指定すると、ROS は指定したリソースタイプで、かつ指定したリソースグループに属するリソースのみをスキャンします。リソースタイプを指定しない場合、ROS は指定したリソースグループに属するすべてのリソースをスキャンします。 指定できるリソースタイプは最大 20 個です。 |
ALIYUN::ECS::VPC |
|
| PreferenceParameters |
array<object> |
任意 |
リソースシナリオのプリファレンスパラメーターです。 |
|
|
object |
任意 |
シナリオのプリファレンスパラメーターです。 |
||
| ParameterKey |
string |
必須 |
パラメーター名です。 ParameterKey の有効な値の詳細については、このトピックの「追加のリクエストパラメーター情報」セクションをご参照ください。 説明
|
DeletionPolicy |
| ParameterValue |
string |
必須 |
パラメーター値です。ParameterValue の値は、ParameterKey の値によって異なります。 ParameterKey の有効な値の詳細については、このトピックの「追加のリクエストパラメーター情報」セクションをご参照ください。 説明
PreferenceParameters は任意です。PreferenceParameters を指定する場合は、ParameterKey と ParameterValue の両方を指定する必要があります。 |
Retain |
| LogicalIdStrategy |
string |
任意 |
論理 ID の生成ポリシーです。有効な値:
説明
TemplateScratchType を ArchitectureDetection に設定した場合、LogicalIdStrategy のデフォルト値は LongTypePrefixAndHashSuffix です。それ以外の場合、LogicalIdStrategy のデフォルト値は LongTypePrefixAndIndexSuffix です。 |
LongTypePrefixAndIndexSuffix |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するためのクライアントトークンです。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。 詳細については、「べき等性を確保する方法」をご参照ください。 |
123e4567-e89b-12d3-a456-42665544**** |
| ExecutionMode |
string |
任意 |
実行モードです。有効な値:
説明
リソースの範囲が広い場合、Sync は時間がかかります。ExecutionMode を Sync に設定する場合は、実行のタイムアウトを防ぐために、ClientToken を指定することを推奨します。 |
Sync |
| ResourceGroupId |
string |
任意 |
リソースグループの ID です。 |
rg-acfmxazb4ph6aiy**** |
リクエストパラメーターの追加情報
共通リクエストパラメーターの詳細については、「Common parameters」をご参照ください。
リクエストパラメーター ParameterKey と ParameterValue の有効な値は、リソースシナリオのタイプによって異なります。
リソース複製シナリオ
次の表に、TemplateScratchId をリソース複製シナリオの ID に設定した場合の、リクエストパラメーター ParameterKey と ParameterValue の有効な値を示します。
| ParameterKey | ParameterValue |
| DeletionPolicy | リソースの削除ポリシーです。有効な値: Retain:リソースの複製先スタックを削除する際に、リソースを保持します。 Delete:リソースの複製先スタックを削除する際に、デフォルトでリソースを削除します。[Delete Stack] ダイアログボックスが表示されたときに特定のリソースを保持する場合、そのリソースは保持されます。 |
| RegionId | リソースを複製する送信先リージョンの ID です。このパラメーターを空のままにすると、複製後のリソースではソースリソースのリージョンが使用されます。例: cn-shanghai。 |
| ZoneId | リソースを複製する送信先ゾーンの ID です。同一リージョン内でリソースを複製し、このパラメーターを空のままにすると、複製後のリソースではソースリソースのゾーンが使用されます。リージョンをまたいでリソースを複製し、このパラメーターを空のままにすると、システムはすべてのリソースに対応しているゾーンをフィルタリングします。例: cn-shanghai-b。 |
| VpcId | リソースを複製する送信先 Virtual Private Cloud (VPC) の ID です。同一リージョン内でリソースを複製し、このパラメーターを空のままにすると、複製後のリソースではソースリソースの VPC が使用されます。リージョンをまたいでリソースを複製し、このパラメーターを空のままにすると、システムは送信先リージョンに VPC を自動作成します。例: vpc-bp1hye0s8b69xokfu****。 |
| VSwitchId | リソースを複製する送信先 vSwitch の ID です。同一リージョン内でリソースを複製し、このパラメーターを空のままにすると、複製後のリソースではソースリソースの vSwitch が使用されます。リージョンをまたいでリソースを複製し、このパラメーターを空のままにすると、システムは送信先リージョンに vSwitch を自動作成します。例: vsw-bp11ufkwqwggtm1cj****。 |
| InstanceDataReplication | Elastic Compute Service (ECS) インスタンスのデータを複製するかどうかを指定します。有効な値: true:ECS インスタンスのデータを複製します。同一リージョン内でデータを複製する場合、システムはソースインスタンスのカスタムイメージを作成し、そのイメージに基づいてインスタンスを作成します。リージョンをまたいでデータを複製する場合、システムはソースインスタンスのカスタムイメージを作成し、そのイメージを送信先リージョンに複製した後、そのイメージに基づいてインスタンスを作成します。 false:ECS インスタンスのデータを複製しません。 |
Note ParameterKey を InstanceDataReplication に、ParameterValue を true に設定する場合は、ソースインスタンスを停止した後にリソースを複製することを推奨します。これにより、データの一貫性が確保されます。
リソース管理シナリオ
次の表に、TemplateScratchId をリソース管理シナリオの ID に設定した場合の、リクエストパラメーター ParameterKey と ParameterValue の有効な値を示します。
Note リソース管理シナリオの場合は、ParameterKey を DeletionPolicy に設定する必要があります。
| ParameterKey | ParameterValue |
| DeletionPolicy | リソースの削除ポリシーです。有効な値: Retain:リソースの管理に使用するスタックを削除する際に、リソースを保持します。 Delete:リソースの管理に使用するスタックを削除する際に、デフォルトでリソースを削除します。[Delete Stack] ダイアログボックスが表示されたときに特定のリソースを保持する場合、そのリソースは保持されます。 |
リソース検出シナリオ
次の表に、TemplateScratchId をリソース検出シナリオの ID に設定した場合の、リクエストパラメーター ParameterKey と ParameterValue の有効な値を示します。
| ParameterKey | ParameterValue |
| RegionIds | 1 つ以上のリージョン ID です。複数のリージョン ID はカンマ (,) で区切ります。このパラメーターを空のままにすると、リソースシナリオのリージョンが使用されます。RegionIds と SourceResources を同時に指定することはできません。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID です。 |
221DA822-B8CF-50DF-A9D2-BA197BF97BD5 |
| TemplateScratchId |
string |
シナリオ ID です。 |
ts-7f7a704cf71c49a6**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "221DA822-B8CF-50DF-A9D2-BA197BF97BD5",
"TemplateScratchId": "ts-7f7a704cf71c49a6****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。