:スタック操作

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-hangzhou

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackName

String

課金されます

MyStack

スタック名。

名前の長さは最大255文字で、数字、文字、ハイフン (-) 、およびアンダースコア (_) を使用できます。 数字または文字で始まる必要があります。

-- TimeoutInMinutes

Long

課金されます

10

スタックを作成するためのタイムアウト期間。

• デフォルト値: 0。

• 単位は分です。

-- Parameters.N.ParameterKey

String

課金されません

InstanceId

パラメータNの名前。パラメーターの名前と値を指定しない場合、Resource Orchestration Service (ROS) は、テンプレートで指定された既定の名前と値を使用します。

Nの最大値: 200。

-- Parameters.N.ParameterValue

String

課金されません

i-xxxxxx

パラメータNの値。

Nの最大値: 200。

-- DisableRollback

ブール値

課金されません

false

スタックの作成に失敗したときにロールバックを無効にするかどうかを指定します。

• true

• false (デフォルト)

-- TemplateBody

String

課金されません

{"ROSTemplateFormatVersion": "2015-09-01"}

テンプレート本体を含む構造。 テンプレート本体の長さは1〜524,288バイトである必要があります。

テンプレートボディの長さが上限を超える場合は、HTTP POSTリクエストボディにパラメーターを追加して、長すぎるURLによるリクエストの失敗を防ぐことをお勧めします。

TemplateBodyとTemplateURLのどちらかを指定できますが、両方を指定することはできません。

-- StackPolicyURL

String

課金されません

oss:// ros-stack-policy/demo

スタックポリシーを含むファイルのURL。 URLは、OSS: // ros/stack-policy/demoやoss:// ros/stack-policy/demo?RegionId=cn-hangzhouなど、HTTPまたはHTTPS webサーバーまたはObject Storage Service (oss) バケットにあるポリシーを指す必要があります。 ポリシーファイルの長さは最大16,384バイトです。

StackPolicyBodyとStackPolicyURLのどちらかを指定できますが、両方を指定することはできません。

URLの長さは最大1,350バイトです。

-- StackPolicyBody

String

課金されません

{"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]}

スタックポリシー本体を含む構造。 ポリシー本体の長さは1〜16,384バイトである必要があります。

StackPolicyBodyとStackPolicyURLのどちらかを指定できますが、両方を指定することはできません。

-- NotificationURL. N

RepeatList

課金されません

http://example.com/ros-event

スタックイベントNを受信するためのコールバックURL。HTTP POSTのみがサポートされています。

• Nの最大値: 5。

• 各URLの長さは最大1,024バイトです。

スタックのステータスが変化すると、ROSは指定されたURLに通知を送信します。 スタックのロールバックが有効になっている場合、スタックがCREATE_ROLLBACKまたはrollback状態の場合は通知が送信されますが、スタックがCREATE_FAILED、UPDATE_FAILED、またはIN_PROGRESS状態の場合は通知は送信されません。

ROSは、[出力] セクションを設定するかどうかに関係なく通知を送信します。 次のサンプルコードは、通知の内容の例を示しています。

{
    "Outputs": [
        {
            "説明": "説明はありません" 、
            "OutputKey": "InstanceId" 、
            "OutputValue": "i-xxx"
        }
    ],
    "StackId": "80bd6b6c-e888-4573-ae3b-93d29113 ****" 、
    "StackName": "test-notification-url" 、
    "ステータス": "CREATE_COMPLETE"
} 

-- TemplateURL

String

課金されません

oss:// ros-template/demo

テンプレート本体を含むファイルのURL。 URLは、OSS: // ros/template/demoまたはoss:// ros/template/demo?RegionId=cn-hangzhouなど、HTTPまたはHTTPS webサーバーまたはossバケットにあるテンプレートを指す必要があります。 テンプレート本体の長さは最大524,288バイトです。

TemplateBodyとTemplateURLのどちらかを指定できますが、両方を指定することはできません。

-- ClientToken

String

課金されません

123e4567-e89b-12d3-a456-42665544 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。

トークンの長さは最大64文字で、英数字、ハイフン (-) 、およびアンダースコア (_) のみを使用できます。

詳細については、「べき等性の確保」をご参照ください。

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-hangzhou

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackName.N

RepeatList

課金されません

MyStack

スタックNの名前。

名前の長さは最大255文字で、数字、文字、ハイフン (-) 、およびアンダースコア (_) を使用できます。 数字または文字で始まる必要があります。 ワイルドカード文字 (*) によるあいまい検索がサポートされています。

N の有効値は 1～5 です。

-- Status.N

RepeatList

課金されません

CREATE_COMPLETE

スタック状態N…

有効な値：

• CREATE_IN_PROGRESS

• CREATE_FAILED

• CREATE_COMPLETE

• UPDATE_IN_PROGRESS

• UPDATE_FAILED

• UPDATE_COMPLETE

• DELETE_IN_PROGRESS

• DELETE_FAILED

• DELETE_COMPLETE

• ROLLBACK_IN_PROGRESS

• ROLLBACK_FAILED

• ROLLBACK_COMPLETE

• CHECK_IN_PROGRESS

• チェック_失敗

• CHECK_COMPLETE

• レビュー_IN_PROGRESS

-- ParentStackId

String

課金されません

fgce558a-bdd6-d52j-555b-63755971 ****

親スタックのID。

-- ShowNestedStack

ブール値

課金されません

true

ネストされたスタックを返すかどうかを指定します。

-- ページ番号

Long

課金されません

1

ページ番号。

• ページは 1 ページ目から始まります。

• デフォルト値は 1 です。

-- PageSize

Long

課金されません

10

1 ページあたりのエントリー数。

• 最大値：100。

• デフォルト値は 10 です。

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-hangzhou

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackId

String

課金されます

4a6c9851-3b0f-4f5f-b4ca-a14bf691 ****

スタックID。

-- ClientToken

String

課金されません

123e4567-e89b-12d3-a456-42665544 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。

トークンの長さは最大64文字で、英数字、ハイフン (-) 、およびアンダースコア (_) のみを使用できます。

詳細については、「べき等性の確保」をご参照ください。

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-beijing

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackId

String

課金されます

4a6c9851-3b0f-4f5f-b4ca-a14bf691 ****

スタックID。

-- Parameters.N.ParameterKey

String

課金されません

InstanceId

パラメータNの名前。パラメーターの名前と値を指定しない場合、ROSはテンプレートで指定された既定の名前と値を使用します。

Nの最大値: 200。

-- Parameters.N.ParameterValue

String

課金されません

i-xxxxxx

パラメータNの値。

Nの最大値: 200。

-- ClientToken

String

課金されません

123e4567-e89b-12d3-a456-42665544 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。

トークンの長さは最大64文字で、英数字、ハイフン (-) 、およびアンダースコア (_) のみを使用できます。

詳細については、「べき等性の確保」をご参照ください。

-- StackPolicyDuringUpdateBody

String

課金されません

{"Statement":[{"Effect": "Allow", "Action": "Update:*", "Principal": "*", "Resource": "*"}]}

一時的なオーバーライドスタックポリシーの本体を含む構造。 ポリシー本体の長さは1〜16,384バイトである必要があります。

保護されたリソースを更新する場合は、更新中に一時的なオーバーライドスタックポリシーを指定する必要があります。 一時的な上書きスタックポリシーを指定しない場合は、スタックに関連付けられている既存のポリシーが使用されます。

このパラメーターは、変更セットがUPDATE型の場合にのみ有効です。 次のいずれかのパラメーターのみを指定できます。

• StackPolicyBody

• StackPolicyURL

• StackPolicyDuringUpdateBody

• StackPolicyDuringUpdateURL

-- TimeoutInMinutes

Long

課金されません

10

スタックを更新するためのタイムアウト期間。

• デフォルト値: 0。

• 単位は分です。

-- TemplateBody

String

課金されません

{"ROSTemplateFormatVersion": "2015-09-01"}

テンプレート本体を含む構造。 テンプレート本体の長さは1〜524,288バイトである必要があります。

テンプレートボディの長さが上限を超える場合は、HTTP POSTリクエストボディにパラメーターを追加して、長すぎるURLによるリクエストの失敗を防ぐことをお勧めします。

TemplateBodyとTemplateURLのどちらかを指定できますが、両方を指定することはできません。

-- StackPolicyURL

String

課金されません

oss:// ros-stack-policy/demo

スタックポリシーを含むファイルのURL。 URLは、OSS: // ros/stack-policy/demoやoss:// ros/stack-policy/demo?RegionId=cn-hangzhouなど、HTTPまたはHTTPS webサーバーまたはossバケットにあるポリシーを指す必要があります。 ポリシーファイルの長さは最大16,384バイトです。

StackPolicyBodyとStackPolicyURLのどちらかを指定できますが、両方を指定することはできません。

URLの長さは最大1,350バイトです。

-- StackPolicyDuringUpdateURL

String

課金されません

oss:// ros-stack-policy/demo

スタック更新ポリシーを含むファイルのURL。 URLは、OSS: // ros/stack-policy/demoやoss:// ros/stack-policy/demo?RegionId=cn-hangzhouなど、HTTPまたはHTTPS webサーバーまたはossバケットにあるポリシーを指す必要があります。 ポリシーファイルの長さは最大16,384バイトです。

URLの長さは最大1,350バイトです。

保護されたリソースを更新する場合は、更新中に一時的なオーバーライドスタックポリシーを指定する必要があります。 一時的な上書きスタックポリシーを指定しない場合は、スタックに関連付けられている既存のポリシーが使用されます。 このパラメーターは、変更セットがUPDATE型の場合にのみ有効です。 次のいずれかのパラメーターのみを指定できます。

• StackPolicyBody

• StackPolicyURL

• StackPolicyDuringUpdateBody

• StackPolicyDuringUpdateURL

-- StackPolicyBody

String

課金されません

{"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]}

スタックポリシー本体を含む構造。 ポリシー本体の長さは1〜16,384バイトである必要があります。

StackPolicyBodyとStackPolicyURLのどちらかを指定できますが、両方を指定することはできません。

-- UsePreviousParameters

ブール値

課金されません

true

現在のリクエストで指定していないパラメーターに対して、前のリクエストで指定した値を使用するかどうかを指定します。

-- DisableRollback

ブール値

課金されません

false

スタックの更新に失敗したときにロールバックを無効にするかどうかを指定します。 有効な値：

• true

• false (デフォルト)

-- TemplateURL

String

課金されません

oss:// ros-template/demo

テンプレート本体を含むファイルのURL。 URLは、OSS: // ros/template/demoまたはoss:// ros/template/demo?RegionId=cn-hangzhouなど、HTTPまたはHTTPS webサーバーまたはossバケットにあるテンプレートを指す必要があります。 テンプレート本体の長さは最大524,288バイトです。

TemplateBodyとTemplateURLのどちらかを指定できますが、両方を指定することはできません。

URLの長さは最大1,024バイトです。

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-beijing

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackName

String

課金されます

MyStack

スタック名。

名前の長さは最大255文字で、数字、文字、ハイフン (-) 、およびアンダースコア (_) を使用できます。 数字または文字で始まる必要があります。 ワイルドカード文字 (*) によるあいまい検索がサポートされています。

-- TimeoutInMinutes

Long

課金されます

10

スタックを作成するためのタイムアウト期間。

• デフォルト値: 0。

• 単位は分です。

-- Parameters.N.ParameterValue

String

課金されません

ecs.cm4.6xlarge

パラメータNの値。

Nの最大値: 200。

-- Parameters.N.ParameterKey

String

課金されません

InstanceType

パラメータNの名前。パラメーターの名前と値を指定しない場合、ROSはテンプレートで指定された既定の名前と値を使用します。

Nの最大値: 200。

-- DisableRollback

ブール値

課金されません

false

スタックの作成に失敗したときにロールバックを無効にするかどうかを指定します。

• true

• false (デフォルト)

-- TemplateBody

String

課金されません

{"ROSTemplateFormatVersion": "2015-09-01"}

テンプレート本体を含む構造。 テンプレート本体の長さは1〜524,288バイトである必要があります。

テンプレートボディの長さが上限を超える場合は、HTTP POSTリクエストボディにパラメーターを追加して、長すぎるURLによるリクエストの失敗を防ぐことをお勧めします。

TemplateBodyとTemplateURLのどちらかを指定できますが、両方を指定することはできません。

-- StackPolicyURL

String

課金されません

oss:// ros-stack-policy/demo

スタックポリシーを含むファイルのURL。 URLは、OSS: // ros/stack-policy/demoやoss:// ros/stack-policy/demo?RegionId=cn-hangzhouなど、HTTPまたはHTTPS webサーバーまたはossバケットにあるポリシーを指す必要があります。 ポリシーファイルの長さは最大16,384バイトです。

StackPolicyBodyとStackPolicyURLのどちらかを指定できますが、両方を指定することはできません。

URLの長さは最大1,350バイトです。

-- StackPolicyBody

String

課金されません

{"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]}

スタックポリシー本体を含む構造。 ポリシー本体の長さは1〜16,384バイトである必要があります。

StackPolicyBodyとStackPolicyURLのどちらかを指定できますが、両方を指定することはできません。

-- TemplateURL

String

課金されません

oss:// ros-template/demo

テンプレート本体を含むファイルのURL。 URLは、OSS: // ros/template/demoまたはoss:// ros/template/demo?RegionId=cn-hangzhouなど、HTTPまたはHTTPS webサーバーまたはossバケットにあるテンプレートを指す必要があります。 テンプレート本体の長さは最大524,288バイトです。

TemplateBodyとTemplateURLのどちらかを指定できますが、両方を指定することはできません。

-- ClientToken

String

課金されません

123e4567-e89b-12d3-a456-42665544 ****

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。

トークンの長さは最大64文字で、英数字、ハイフン (-) 、およびアンダースコア (_) のみを使用できます。

詳細については、「べき等性の確保」をご参照ください。

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-hangzhou

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackId

String

課金されます

4a6c9851-3b0f-4f5f-b4ca-a14bf691f2ff

スタックID。

-- RetainAllResources

ブール値

課金されません

false

リソースをスタックに保持するかどうかを指定します。

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-hangzhou

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackId

String

課金されます

4a6c9851-3b0f-4f5f-b4ca-a14bf691 ****

スタックID。

-- CancelType

String

課金されません

安全

スタックの更新をキャンセルするメソッド。 DisableRollbackをtrueに設定することを推奨します。 有効な値：

• クイック: できるだけ早くスタックの更新をキャンセルします。

• セーフ: できるだけ安全にスタックの更新をキャンセルします。

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-hangzhou

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackId

String

課金されます

4a6c9851-3b0f-4f5f-b4ca-a14bf691 ****

スタックID。

-RecreatingResources.N

RepeatList

課金されません

WebServer

リソースの作成に失敗した後もROSが作成し続けるリソースN。

ROSが引き続き作成するリソースに新しいリソースを追加できます。 ROSは、新しいリソースのすべての依存関係を作成し続けます。

パラメーター

データ型

必須

例

説明

-- RegionId

String

課金されます

cn-hangzhou

スタックのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

-- StackId

String

課金されます

4a6c9851-3b0f-4f5f-b4ca-a14bf691 ****

スタックID。

-- Status.N

RepeatList

課金されません

CREATE_IN_PROGRESS

リソース状態N。有効な値:

• CREATE_COMPLETE

• CREATE_FAILED

• CREATE_IN_PROGRESS

• DELETE_FAILED

• DELETE_IN_PROGRESS

• ROLLBACK_COMPLETE

• ROLLBACK_FAILED

• ROLLBACK_IN_PROGRESS

-- ResourceType.N

RepeatList

課金されません

ALIYUN::ECS::Instance

リソースタイプN。

Nの最大値: 200。

-- ページ番号

Long

課金されません

1

ページ番号。

• ページは 1 ページ目から始まります。

• デフォルト値は 1 です。

-- PageSize

Long

課金されません

10

1 ページあたりのエントリー数。

• 最大値：100。

• デフォルト値は 10 です。