既存のスタックグループを更新します。
操作説明
このトピックでは、スタックグループ MyStackGroup のテンプレートを {"ROSTemplateFormatVersion": "2015-09-01"} に更新する方法の例を示します。このスタックグループは中国 (杭州) リージョンにあり、セルフマネージド権限を使用します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ros:UpdateStackGroup |
update |
*StackGroup
Template
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
スタックグループが配置されているリージョンの ID。DescribeRegions 操作を呼び出して、Alibaba Cloud リージョンの最新リストを照会できます。 |
cn-hangzhou |
| StackGroupName |
string |
必須 |
スタックグループの名前。名前はリージョン内で一意である必要があります。 |
MyStackGroup |
| Description |
string |
任意 |
スタックグループの説明。 説明は 1~256 文字である必要があります。 |
My Stack Group |
| AccountIds |
array |
任意 |
セルフマネージド権限モードでスタックをデプロイする宛先アカウントの ID。最大 50 個の宛先アカウント ID を指定できます。 |
["12****"] |
|
string |
任意 |
セルフマネージド権限モードでスタックをデプロイする宛先アカウントの ID。最大 50 個の宛先アカウント ID を指定できます。 |
["151266687691****","141261387191****"] |
|
| RegionIds |
array |
任意 |
スタックをデプロイするリージョンの ID。最大 20 個のリージョン ID を指定できます。 |
["cn-hangzhou", "cn-beijing"] |
|
string |
任意 |
スタックをデプロイするリージョンの ID。最大 20 個のリージョン ID を指定できます。 |
["cn-hangzhou","cn-beijing"] |
|
| TemplateBody |
string |
任意 |
テンプレート本文を含む構造。テンプレート本文の長さは 1~524,288 バイトである必要があります。テンプレート本文が長い場合は、HTTP POST および Body Param メソッドを使用してリクエスト本文でパラメーターを渡すことで、URL が長すぎることによるリクエストの失敗を防ぎます。 説明
`TemplateBody`、`TemplateURL`、`TemplateId` パラメーターのいずれか 1 つのみを指定できます。 |
{"ROSTemplateFormatVersion": "2015-09-01"} |
| TemplateURL |
string |
任意 |
テンプレート本文を含むファイルの URL。URL は、HTTP または HTTPS Web サーバー、あるいは Alibaba Cloud Object Storage Service (OSS) バケットにあるテンプレートを指す必要があります。テンプレート本文の長さは 1~524,288 バイトである必要があります。たとえば、OSS バケットの URL は oss://ros/template/demo または oss://ros/template/demo?RegionId=cn-hangzhou のようになります。OSS バケットのリージョンを指定しない場合は、`RegionId` パラメーターの値が使用されます。 説明
`TemplateBody`、`TemplateURL`、`TemplateId` パラメーターのいずれか 1 つのみを指定できます。 |
oss://ros-template/demo |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。 |
123e4567-e89b-12d3-a456-42665544**** |
| OperationDescription |
string |
任意 |
スタックグループを更新する操作の説明。 |
Update stack instances in hangzhou |
| OperationPreferences |
object |
任意 |
スタックグループ操作のプリファレンス。 次のパラメーターが含まれます:
複数のパラメーターはコンマ (,) で区切ります。 説明
|
{"FailureToleranceCount": 1,"MaxConcurrentCount": 2} |
| AdministrationRoleName |
string |
任意 |
ROS によって引き受けられる RAM 管理者ロールの名前。このパラメーターは、セルフマネージド権限を持つスタックグループを作成する場合に必要です。値を指定しない場合、デフォルト値として `AliyunROSStackGroupAdministrationRole` が使用されます。ROS はこのロールを引き受けて、スタックグループ内のスタックに対する操作を実行します。ROS はこのロールの認証情報を使用して、実行ロール (`AliyunROSStackGroupExecutionRole`) を引き受けます。 名前は 1~64 文字で、文字、数字、ハイフン (-) を使用できます。 |
AliyunROSStackGroupAdministrationRole |
| ExecutionRoleName |
string |
任意 |
管理者ロール (`AliyunROSStackGroupAdministrationRole`) によって引き受けられる RAM 実行ロールの名前。このパラメーターは、セルフマネージド権限を持つスタックグループを作成する場合に必要です。値を指定しない場合、デフォルト値として `AliyunROSStackGroupExecutionRole` が使用されます。ROS はこのロールを引き受けて、スタックグループ内のスタックに対する操作を実行します。 名前は 1~64 文字で、文字、数字、ハイフン (-) を使用できます。 |
AliyunROSStackGroupExecutionRole |
| TemplateId |
string |
任意 |
テンプレートの ID。このパラメーターは、共有テンプレートとプライベートテンプレートに適用されます。 説明
`TemplateBody`、`TemplateURL`、`TemplateId` パラメーターのいずれか 1 つのみを指定できます。 |
5ecd1e10-b0e9-4389-a565-e4c15efc**** |
| TemplateVersion |
string |
任意 |
テンプレートのバージョン。このパラメーターを指定しない場合、最新バージョンが使用されます。 説明
`TemplateVersion` は `TemplateId` が指定されている場合にのみ有効です。 |
v1 |
| Parameters |
array<object> |
任意 |
スタックグループのパラメーター。 |
|
|
object |
任意 |
|||
| ParameterKey |
string |
必須 |
パラメーターのキー。パラメーターのキーと値を指定しない場合、ROS はテンプレートで指定されたデフォルトの名前と値を使用します。 最大 200 個のパラメーターを指定できます。 説明
`Parameters` パラメーターはオプションです。`Parameters` を指定する場合は、`Parameters.N.ParameterKey` を指定する必要があります。 |
Amount |
| ParameterValue |
string |
必須 |
パラメーターの値。 最大 200 個のパラメーターを指定できます。 説明
`Parameters` パラメーターはオプションです。`Parameters` を指定する場合は、`Parameters.N.ParameterValue` を指定する必要があります。 |
1 |
| PermissionModel |
string |
任意 |
権限モデル。 有効な値:
説明
|
SELF_MANAGED |
| AutoDeployment |
object |
任意 |
自動デプロイ設定。 説明
このパラメーターは、`PermissionModel` が `SERVICE_MANAGED` に設定されている場合にのみ必要です。 |
{"Enabled": true, "RetainStacksOnAccountRemoval": true} |
| Enabled |
boolean |
必須 |
自動デプロイを有効にするかどうかを指定します。 有効な値:
|
true |
| RetainStacksOnAccountRemoval |
boolean |
任意 |
フォルダから削除されたメンバーアカウントのスタックを保持するかどうかを指定します。 有効な値:
説明
このパラメーターは、`Enabled` が true に設定されている場合にのみ必要です。 |
true |
| DeploymentTargets |
object |
任意 |
サービスマネージド権限モードでスタックをデプロイするデプロイターゲット。 |
{"RdFolderIds": ["fd-4PvlVLOL8v"]} |
| RdFolderIds |
array |
任意 |
リソースディレクトリ内のフォルダの ID。 |
|
|
string |
任意 |
リソースディレクトリ内のフォルダの ID。最大 20 個のフォルダ ID を指定できます。 `RdFolderIds` と `AccountIds` パラメーターの少なくとも 1 つを指定する必要があります。パラメーターについては、次のセクションで説明します:
説明
フォルダ ID は、Resource Management コンソールの [概要] ページで確認できます。詳細については、「フォルダの基本情報の表示」をご参照ください。 |
["fd-4PvlVLOL8v"] |
|
| AccountIds |
array |
任意 |
リソースディレクトリ内のメンバーアカウントの ID。最大 30 個のメンバーアカウント ID を指定できます。 説明
メンバーアカウント ID は、Resource Management コンソールの [概要] ページで確認できます。詳細については、「メンバーの詳細の表示」をご参照ください。 |
|
|
string |
任意 |
リソースディレクトリ内のメンバーアカウントの ID。最大 30 個のメンバーアカウント ID を指定できます。 説明
メンバーアカウント ID は、Resource Management コンソールの [概要] ページで確認できます。詳細については、「メンバーの詳細の表示」をご参照ください。 |
["151266687691****","141261387191****"] |
|
| Capabilities |
array |
任意 |
スタックグループのオプション。最大 1 つのオプションを指定できます。 |
|
|
string |
任意 |
スタックグループのオプション。有効な値:`ExpandModules`。このオプションは、現在のアカウントでモジュールを展開します。 説明
|
ExpandModules |
|
| DeploymentOptions |
array |
任意 |
サービスマネージド権限を持つスタックグループのデプロイオプション。最大 1 つのデプロイオプションを指定できます。 |
|
|
string |
任意 |
有効な値:
|
共通パラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID。 |
14A07460-EBE7-47CA-9757-12CC4761D47A |
| OperationId |
string |
操作の ID。 |
6da106ca-1784-4a6f-a7e1-e723863d**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。