スタックの変更セットを作成します。変更セットを実行する前に変更をプレビューできます。
操作説明
シナリオ
変更セットを使用してスタックを作成する
複数のクラウドリソースを管理し、スタックが作成される前にどのように作成されるかをプレビューする場合は、変更セットを使用してスタックを作成できます。これを行うには、ChangeSetType パラメーターを CREATE に設定し、他の必須パラメーターを設定します。変更セットの詳細については、「変更セット」をご参照ください。
変更セットを使用してスタックを更新する
変更を適用する前に、更新がスタックに与える影響をプレビューする場合は、既存のスタックの変更セットを作成できます。これを行うには、ChangeSetType パラメーターを UPDATE に設定し、他の必須パラメーターを設定します。 変更セットの詳細については、「変更セット」をご参照ください。
既存のリソースからスタックを作成する
既存のクラウドリソースを集中管理のために新しいスタックにインポートする場合は、変更セットを作成できます。これを行うには、ChangeSetType パラメーターを IMPORT に設定し、他の必須パラメーターを設定します。リソースのインポートの詳細については、「概要」をご参照ください。
既存のリソースをスタックにインポートする
既存のリソースを集中管理のために既存のスタックにインポートする場合は、変更セットを作成できます。これを行うには、ChangeSetType パラメーターを IMPORT に設定し、他の必須パラメーターを設定します。リソースのインポートの詳細については、「概要」をご参照ください。
制限
変更セットを使用して、特定の状態のスタックのみを更新できます。詳細については、「変更セットを使用してスタックを更新する」をご参照ください。
スタックは一度に最大 20 個の変更セットを持つことができます。
変更セットには、スタックへの変更のみが表示されます。スタックが正常に更新されるかどうかは示されません。
変更セットは、アカウントクォータの超過、更新できないリソースの更新の試み、リソースを変更するための十分な権限がないなど、潜在的な問題をチェックしません。これらの問題のいずれかが発生すると、スタックの更新が失敗する可能性があります。更新が失敗した場合、ROS はリソースを以前の状態にロールバックしようとします。
このトピックでは、中国 (杭州) リージョン (cn-hangzhou) に MyChangeSet という名前の変更セットを作成する例を示します。変更セットは、ID が 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** のスタックのテンプレートを {"ROSTemplateFormatVersion":"2015-09-01"} に更新します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ros:CreateChangeSet |
create |
*Stack
Template
|
なし | なし |
リクエストパラメーター
|
パラメーター |
タイプ |
必須 / 任意 |
説明 |
例 |
| StackId |
string |
任意 |
変更セットを作成するスタックの ID です。ROS は、変更されたテンプレートや異なるパラメーター値など、送信した情報とスタック情報を比較して、変更セットを生成します。 説明
このパラメーターは、ChangeSetType が UPDATE または IMPORT に設定されている場合にのみ有効です。 |
4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
| StackPolicyURL |
string |
任意 |
スタックポリシーを含むファイルの URL です。URL は、Web サーバー (HTTP または HTTPS) または Alibaba Cloud OSS バケットにあるポリシーを指している必要があります (例: oss://ros/stack-policy/demo または oss://ros/stack-policy/demo?RegionId=cn-hangzhou)。ポリシーファイルのサイズは最大 16,384 バイトです。 URL の長さは最大 1,350 バイトです。 説明
OSS バケットのリージョンを指定しない場合、RegionId の値が使用されます。 ChangeSetType が CREATE に設定されている場合、StackPolicyBody と StackPolicyURL パラメーターのいずれか 1 つのみを指定できます。 ChangeSetType が UPDATE に設定されている場合、次のパラメーターのいずれか 1 つのみを指定できます。
|
oss://ros/stack-policy/demo |
| StackPolicyBody |
string |
任意 |
スタックポリシーの構造。ポリシー本文の長さは 1 ~ 16,384 バイトである必要があります。 ChangeSetType が CREATE に設定されている場合、StackPolicyBody と StackPolicyURL パラメーターのいずれか 1 つのみを指定できます。 ChangeSetType が UPDATE に設定されている場合、次のパラメーターのいずれか 1 つのみを指定できます。
|
{"Statement":[{"Effect":"Allow","Action":"Update:*","Principal":"*","Resource":"*"}]} |
| StackName |
string |
任意 |
変更セットを作成するスタックの名前です。 説明
このパラメーターは、ChangeSetType が CREATE または IMPORT に設定されている場合にのみ有効です。 |
MyStack |
| UsePreviousParameters |
boolean |
任意 |
最後に使用されたパラメーターの値を使用するかどうかを指定します。有効な値:
説明
このパラメーターは、ChangeSetType が UPDATE または IMPORT に設定されている場合にのみ有効です。 |
true |
| ChangeSetType |
string |
任意 |
変更セットのタイプ。有効な値:
ChangeSetType の値を CREATE に設定すると、ROS は新しいスタックを作成します。スタックは、変更セットを実行するまで 説明
|
UPDATE |
| Description |
string |
任意 |
変更セットの説明。説明の長さは最大 1,024 バイトです。 |
It is a demo. |
| RegionId |
string |
必須 |
変更セットのリージョン ID です。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。 |
123e4567-e89b-12d3-a456-42665544**** |
| TemplateURL |
string |
任意 |
テンプレート本文を含むファイルの URL です。URL は、Web サーバー (HTTP または HTTPS) または OSS バケットにあるテンプレートを指している必要があります (例: oss://ros/template/demo または oss://ros/template/demo?RegionId=cn-hangzhou)。テンプレート本文の長さは最大 524,288 バイトです。 説明
OSS バケットのリージョンを指定しない場合、RegionId の値が使用されます。 TemplateBody、TemplateURL、TemplateId パラメーターのいずれか 1 つのみを指定できます。 URL の長さは最大 1,024 バイトです。 |
oss://ros/template/demo |
| StackPolicyDuringUpdateURL |
string |
任意 |
一時的なオーバーライドスタックポリシーを含むファイルの URL です。URL は、Web サーバー (HTTP または HTTPS) または OSS バケットにあるポリシーを指している必要があります (例: oss://ros/stack-policy/demo または oss://ros/stack-policy/demo?RegionId=cn-hangzhou)。ポリシーファイルのサイズは最大 16,384 バイトです。 説明
OSS バケットのリージョンを指定しない場合、RegionId の値が使用されます。 URL の長さは最大 1,350 バイトです。
|
oss://ros/stack-policy/demo |
| TemplateBody |
string |
任意 |
テンプレート本文の構造。テンプレート本文の長さは 1 ~ 524,288 バイトである必要があります。テンプレート本文の長さが要件よりも長い場合は、URL が長すぎることによるリクエストの失敗を防ぐために、HTTP POST リクエスト本文にパラメーターを追加することをお勧めします。 説明
TemplateBody、TemplateURL、TemplateId パラメーターのいずれか 1 つのみを指定できます。 |
{"ROSTemplateFormatVersion":"2015-09-01"} |
| TimeoutInMinutes |
integer |
任意 |
スタックが CREATE_FAILED または UPDATE_FAILED 状態になるまでに経過できる時間です。
|
12 |
| DisableRollback |
boolean |
任意 |
スタックの作成に失敗した場合にロールバックを無効にするかどうかを指定します。
説明
このパラメーターは、ChangeSetType が CREATE または IMPORT に設定されている場合にのみ有効です。 |
false |
| ChangeSetName |
string |
必須 |
変更セットの名前です。 説明
変更セットの名前は、スタック内で一意である必要があります。 |
MyChangeSet |
| StackPolicyDuringUpdateBody |
string |
任意 |
一時的なオーバーライドスタックポリシーの構造。ポリシー本文の長さは 1 ~ 16,384 バイトである必要があります。
|
{"Statement":[{"Effect":"Allow","Action":"Update:*","Principal":"*","Resource":"*"}]} |
| RamRoleName |
string |
任意 |
RAM ロールの名前。ROS は RAM ロールをアシュームしてスタックを作成し、ロールの資格情報を使用して Alibaba Cloud サービスの API を呼び出します。 RAM ロールの詳細については、「スタックロール」をご参照ください。 |
test-role |
| ReplacementOption |
string |
任意 |
リソースプロパティが変更され、変更が変更更新をサポートしていない場合に、置換更新を有効にするかどうかを指定します。置換更新では、リソースを削除し、新しいリソースを作成します。リソースの物理 ID が変更されます。有効な値:
説明
変更更新が優先的に使用されます。このパラメーターは、ChangeSetType が UPDATE に設定されている場合にのみ有効です。 |
Disabled |
| TemplateId |
string |
任意 |
テンプレート ID。このパラメーターは、共有テンプレートと非公開テンプレートに適用されます。 ListTemplates 操作を呼び出して、テンプレート ID をクエリできます。 説明
TemplateBody、TemplateURL、TemplateId パラメーターのいずれか 1 つのみを指定できます。 |
5ecd1e10-b0e9-4389-a565-e4c15efc**** |
| TemplateVersion |
string |
任意 |
テンプレートのバージョン。 説明
このパラメーターは、TemplateId が指定されている場合にのみ有効です。 |
v1 |
| Parameters |
array<object> |
任意 |
テンプレートで定義されているパラメーター。 |
|
|
object |
任意 |
|||
| ParameterKey |
string |
必須 |
テンプレートで定義されているパラメーターの名前。パラメーターの名前と値を指定しない場合、ROS はテンプレートで指定されているデフォルトの名前と値を使用します。N の値は最大 200 です。 説明
パラメーターパラメーターはオプションです。パラメーターを指定する場合は、Parameters.N.ParameterKey も指定する必要があります。 |
Amount |
| ParameterValue |
string |
必須 |
テンプレートで定義されているパラメーターの値。N の値は最大 200 です。 説明
パラメーターパラメーターはオプションです。パラメーターを指定する場合は、Parameters.N.ParameterValue も指定する必要があります。 |
12 |
| NotificationURLs |
array |
任意 |
スタックイベント通知を受信するための Webhook アドレスのリスト。 |
http://my-site.com/ros-notify |
|
string |
任意 |
スタックイベント通知を受信するための Webhook アドレス。有効な値:
説明
この機能は、中国 (杭州)、中国 (上海)、中国 (北京)、中国 (香港)、中国 (張家口) リージョンでサポートされています。 N の値は最大 5 です。スタックのステータスが変更されると、通知が送信されます。スタックでロールバックが有効になっている場合、CREATE_FAILED および UPDATE_FAILED 状態の通知は送信されません。代わりに、CREATE_ROLLBACK および ROLLBACK 状態の通知が送信されます。IN_PROGRESS 状態は報告されません。 |
http://example.com/ros-notify |
|
| ResourcesToImport |
array<object> |
任意 |
インポートされるリソースのリスト。 |
|
|
object |
任意 |
|||
| ResourceIdentifier |
string |
任意 |
文字列間のキーと値のマッピング。値は、インポートするリソースを識別するために使用される JSON 文字列です。 GetTemplateSummary 操作を呼び出して、リソースの識別子プロパティをクエリできます。 説明
このパラメーターは、ChangeSetType が IMPORT に設定されている場合にのみ有効です。ResourcesToImport パラメーターはオプションです。ResourcesToImport を指定する場合は、ResourcesToImport.N.ResourceIdentifier も指定する必要があります。 |
{"VpcId": "vpc-2zevx9ios******"} |
| LogicalResourceId |
string |
任意 |
リソースの論理 ID。論理 ID は、テンプレートで定義されているリソース名です。 説明
このパラメーターは、ChangeSetType が IMPORT に設定されている場合にのみ有効です。ResourcesToImport パラメーターはオプションです。ResourcesToImport を指定する場合は、ResourcesToImport.N.LogicalResourceId も指定する必要があります。 |
Vpc |
| ResourceType |
string |
任意 |
リソースのタイプ。リソースタイプは、テンプレートで定義されているリソースタイプと同じである必要があります。 説明
このパラメーターは、ChangeSetType が IMPORT に設定されている場合にのみ有効です。ResourcesToImport パラメーターはオプションです。ResourcesToImport を指定する場合は、ResourcesToImport.N.ResourceType も指定する必要があります。 |
ALIYUN::ECS::VPC |
| TemplateScratchId |
string |
任意 |
リソースシナリオ ID。これはリソース管理シナリオ ID です。 このパラメーターは、ChangeSetType が IMPORT に設定されている場合にのみ有効です。このパラメーターは、リソースのインポートのための新しいスタックの作成のみをサポートします。 リソース管理シナリオでリソースをインポートする場合は、このパラメーターのみを指定します。テンプレート関連のパラメーターは指定しないでください。 ListTemplateScratches 操作を呼び出して、リソース管理シナリオ ID をクエリできます。 |
4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
| Parallelism |
integer |
任意 |
リソースに対して同時に実行できる操作の最大数。デフォルト値は空で、値が 0 以上の整数であることを指定します。このパラメーターを設定すると、値はスタックに関連付けられ、スタックに対する後続の操作に影響します。 このパラメーターは、ChangeSetType が CREATE または UPDATE に設定されている場合にのみ有効です。有効な値:
|
1 |
| Tags |
array<object> |
任意 |
変更セットのタグ。 |
|
|
object |
任意 |
変更セットのタグ。 |
||
| Key |
string |
任意 |
スタックのタグキー。 N の値は 1 ~ 20 です。 説明
|
|
| Value |
string |
任意 |
スタックのタグ値。 N の値は 1 ~ 20 です。 説明
タグは、タグをサポートする各スタックリソースに伝播されます。詳細については、「タグを伝播する」をご参照ください。 |
|
| ResourceGroupId |
string |
任意 |
リソースグループ ID。このパラメーターを指定しない場合、スタックはデフォルトのリソースグループに追加されます。 |
|
| TaintResources |
array |
任意 |
ダーティとしてマークされるリソースのリスト。 |
|
|
string |
任意 |
|
共通リクエストパラメーターについては、「共通パラメーター」をご参照ください。
レスポンスパラメーター
|
パラメーター |
タイプ |
説明 |
例 |
|
object |
|||
| ChangeSetId |
string |
変更セットの ID です。 |
e85abe0c-6528-43fb-ae93-fdf8de22**** |
| RequestId |
string |
リクエスト ID。 |
B288A0BE-D927-4888-B0F7-B35EF84B6E6F |
| StackId |
string |
スタック ID。 |
4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。