Elastic Compute Service:RunCommand

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

コマンド実行のリソースグループ ID。このパラメーターが指定された場合：

• InstanceId に対応する ECS インスタンスがデフォルト以外のリソースグループに属している場合、その ECS インスタンスはこのリソースグループに属している必要があります。

• このパラメーターを指定することで、対応するコマンド実行結果をフィルター処理できます（ DescribeInvocations または DescribeInvocationResults を呼び出すことで可能）。

コマンド名。すべての文字セットがサポートされています。名前の長さは 128 文字を超えることはできません。

コマンドの説明。すべての文字セットがサポートされています。説明の長さは 512 文字を超えることはできません。

コマンドタイプ。有効な値:

• RunBatScript: Windows インスタンス用の Bat コマンド。

• RunPowerShellScript: Windows インスタンス用の PowerShell コマンド。

• RunShellScript: Linux インスタンス用の Shell コマンド。

コマンドコンテンツ。コマンドコンテンツはプレーンテキストまたは Base64 エンコーディングが可能です。以下の点にご注意ください。

• コマンドコンテンツは Base64 エンコーディング後に 24 KB を超えることはできません。KeepCommand を使用してコマンドを保持するかどうかを指定できます。

• コマンドコンテンツが Base64 エンコーディングされている場合、ContentEncoding=Base64 をセットする必要があります。

• EnableParameter=true が指定されている場合、コマンドコンテンツ内でカスタムパラメーター特徴が有効になります。

  • カスタムパラメーターは {{}} で囲んで定義します。{{}} 内のパラメーター名の前後にあるスペースや改行は無視されます。

  • カスタムパラメーターの数は 20 を超えることはできません。

  • カスタムパラメーター名には a-zA-Z0-9-_ の組み合わせを使用できます。組み込み以外の環境パラメータを指定するための acs:: プレフィックスはサポートされていません。その他の文字もサポートされていません。パラメーター名は大文字と小文字が区別されません。

  • 各カスタムパラメーター名の長さは 64 バイトを超えることはできません。

• 組み込み環境パラメータをカスタムパラメーターとして指定できます。コマンドを実行する際、これらのパラメーターに手動で値を割り当てる必要はありません。クラウドアシスタントが自動的に対応する値に置き換えます。以下の組み込み環境パラメータがサポートされています。

  • {{ACS::RegionId}}: リージョン ID。

  • {{ACS::AccountId}}: Alibaba Cloud アカウント ID。

  • {{ACS::InstanceId}}: インスタンス ID。コマンドが複数のインスタンスに送信され、{{ACS::InstanceId}} を組み込み環境パラメータとして使用したい場合は、クラウドアシスタントエージェントのバージョンが以下以降であることを確認してください。

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::InstanceName}}: インスタンス名。コマンドが複数のインスタンスに送信され、{{ACS::InstanceName}} を組み込み環境パラメータとして使用したい場合は、クラウドアシスタントエージェントのバージョンが以下以降であることを確認してください。

    • Linux: 2.2.3.344

    • Windows: 2.1.3.344

  • {{ACS::InvokeId}}: 呼び出し ID。{{ACS::InvokeId}} を組み込み環境パラメータとして使用するには、クラウドアシスタントエージェントのバージョンが以下以降であることを確認してください。

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

  • {{ACS::CommandId}}: コマンド ID。この操作を呼び出してコマンドを実行する際に {{ACS::CommandId}} を組み込み環境パラメータとして使用したい場合は、クラウドアシスタントエージェントのバージョンが以下以降であることを確認してください。

    • Linux: 2.2.3.309

    • Windows: 2.1.3.309

ECS インスタンス上でのコマンドの作業ディレクトリ。値の長さは 200 文字を超えることはできません。

デフォルト値:

• Linux インスタンスの場合、デフォルトディレクトリはルートユーザーのホームディレクトリである /root です。

• Windows インスタンスの場合、デフォルトディレクトリはクラウドアシスタントエージェントプロセスが配置されているディレクトリ（例: C:\Windows\System32）です。

コマンド実行のタイムアウト時間。単位: 秒。

プロセスの問題、モジュールの欠落、またはクラウドアシスタントエージェントの欠落によりコマンドを実行できない場合にタイムアウトが発生します。タイムアウトが発生すると、コマンドプロセスは強制終了されます。

デフォルト値: 60。

コマンドにカスタムパラメーターが含まれるかどうかを指定します。

デフォルト値: false。

コマンドの実行モード。有効な値:

• Once: コマンドを即座に実行します。

• Period: コマンドをスケジュールに従って実行します。このパラメーターを Period にセットする場合、Frequency パラメーターも指定する必要があります。

• NextRebootOnly: インスタンスの次回起動時にコマンドを自動的に実行します。

• EveryReboot: インスタンスの起動時に毎回コマンドを自動的に実行します。

• DryRun: 実際にコマンドを実行せずにリクエストのドライランを実行します。チェック項目には、リクエストパラメーター、インスタンスの実行環境、クラウドアシスタントエージェントの実行中ステータスが含まれます。

デフォルト値:

• Frequency パラメーターが指定されていない場合、デフォルト値は Once です。

• Frequency パラメーターが指定されている場合、このパラメーターの設定に関係なく、コマンドは Period として処理されます。

注意事項:

• StopInvocation を呼び出して、保留中またはスケジュール済みのコマンドを停止できます。

• このパラメーターが Period または EveryReboot にセットされている場合、 DescribeInvocationResults を呼び出し IncludeHistory=true を指定することで、スケジュール済みコマンドの実行履歴をビューできます。

[非推奨] このパラメーターは非推奨です。このパラメーターを渡しても効果はありません。

コマンドを実行するスケジュール。3 つのスケジューリングメソッドがサポートされています。固定間隔での実行（レート式に基づく）、指定時刻での 1 回限りの実行、および時計ベースのスケジュール実行（Cron 式に基づく）です。

• 固定間隔での実行: レート式に基づき、指定された間隔でコマンドが実行されます。間隔は秒 (s)、分 (m)、時間 (h)、日 (d) で指定できます。この方法は、タスク実行を固定間隔で実行するシナリオに適しています。形式: rate(<間隔値><間隔単位>)。たとえば、5 分ごとにコマンドを実行するには rate(5m) を使用します。固定間隔実行には以下の制限が適用されます。

  • 間隔は 7 日以下かつ 60 秒以上である必要があり、さらに定期タスクのタイムアウト時間より長くする必要があります。

  • 間隔は固定周波数に基づいており、タスクの実際の実行時間とは関係ありません。たとえば、コマンドが 5 分ごとに実行されるように設定されており、タスクの完了に 2 分かかる場合、次の四捨五入はタスク完了の 3 分後に開始されます。

  • タスクは作成直後には実行されません。たとえば、コマンドが 5 分ごとに実行されるように設定されている場合、タスク作成時にコマンドはすぐには実行されず、タスク作成の 5 分後に実行が開始されます。

• 指定時刻での 1 回限りの実行: 指定されたタイムゾーンと時刻ポイントにコマンドが 1 回実行されます。形式: at(yyyy-MM-dd HH:mm:ss <タイムゾーン>)。タイムゾーンが指定されていない場合、デフォルトで協定世界時 (UTC) が使用されます。タイムゾーンは以下の 3 つの形式をサポートしています。

  • フルタイムゾーン名: Asia/Shanghai（中国/上海時間）や America/Los_Angeles（米国/ロサンゼルス時間）など。

  • グリニッジ標準時からのタイムゾーンオフセット: GMT+8:00（東 8 時区）や GMT-7:00（西 7 時区）など。GMT 形式を使用する場合、時間フィールドでの先行ゼロはサポートされていません。

  • タイムゾーン略語: UTC（協定世界時）のみサポートされています。

  たとえば、2022 年 6 月 6 日の 13:15:30 に中国/上海時間でコマンドを 1 回実行するには、at(2022-06-06 13:15:30 Asia/Shanghai) を使用します。2022 年 6 月 6 日の 13:15:30 に西 7 時区でコマンドを 1 回実行するには、at(2022-06-06 13:15:30 GMT-7:00) を使用します。

• 時計ベースのスケジュール実行（Cron 式に基づく）: Cron 式に基づき、定期タスクの設定に従ってコマンドが実行されます。形式: <秒> <分> <時> <日> <月> <曜日> <年（オプション）> <タイムゾーン>、つまり <Cron 式> <タイムゾーン> です。定期タスクの実行時間は、指定されたタイムゾーンの Cron 式に基づいて計算されます。タイムゾーンが指定されていない場合、デフォルトで定期タスクを実行するインスタンスのシステムタイムゾーンが使用されます。Cron 式の詳細については、「Cron 式」をご参照ください。タイムゾーンは以下の 3 つの形式をサポートしています。

  • フルタイムゾーン名: Asia/Shanghai（中国/上海時間）や America/Los_Angeles（米国/ロサンゼルス時間）など。

  • グリニッジ標準時からのタイムゾーンオフセット: GMT+8:00（東 8 時区）や GMT-7:00（西 7 時区）など。GMT 形式を使用する場合、時間フィールドでの先行ゼロはサポートされていません。

  • タイムゾーン略語: UTC（協定世界時）のみサポートされています。 たとえば、2022 年中毎日午前 10:15 に中国/上海時間でコマンドを実行するには、0 15 10 ? * * 2022 Asia/Shanghai を使用します。2022 年中毎日東 8 時区の午前 10:00 から午前 11:30 まで 30 分ごとにコマンドを実行するには、0 0/30 10-11 * * ? 2022 GMT+8:00 を使用します。2022 年から 2 年ごとの 10 月中毎日午後 2:00 から午後 2:55 まで 5 分ごとに協定世界時 (UTC) でコマンドを実行するには、0 0/5 14 * 10 ? 2022/2 UTC を使用します。

  説明

  最小値間隔は定期タスクのタイムアウト時間以上であり、かつ 10 秒以上である必要があります。

カスタムパラメーターを含むコマンドを実行する際に渡すカスタムパラメーターのキーと値のペア。たとえば、コマンドコンテンツが echo {{name}} の場合、Parameter パラメーターを通じてキーと値のペア {"name":"Jack"} を渡すことができます。カスタムパラメーターは変数値 name を自動的に置換し、実際に実行されるコマンドは echo Jack となります。

カスタムパラメーターの数は 0 から 10 の範囲です。以下の点にご注意ください。

• キーは空文字列にすることはできず、最大 64 文字まで含めることができます。

• 値は空文字列にすることができます。

• カスタムパラメーターと元のコマンドコンテンツを Base64 エンコーディングした後の合計サイズは 24 KB を超えることはできません。KeepCommand を使用してコマンドを保持するかどうかを指定できます。

• カスタムパラメーター名のセットは、コマンド作成時に定義されたパラメーターセットのサブセットである必要があります。渡されないパラメーターについては、空文字列を代用として使用できます。

デフォルト値: 空（カスタムパラメーターは無効）。

実行後にコマンドを保持するかどうかを指定します。有効な値:

• true: コマンドを保持します。InvokeCommand を呼び出すことでコマンドを再実行できます。これはクラウドアシスタントコマンド保持クォータにカウントされます。

• false: コマンドを保持しません。コマンドは実行後に自動的に削除され、クラウドアシスタントコマンド保持クォータにはカウントされません。

デフォルト値: false。

コマンドコンテンツ (CommandContent) のエンコーディング方式。有効な値（大文字と小文字は区別されません）:

• PlainText: エンコーディングなし。コンテンツはプレーンテキストで送信されます。

• Base64: Base64 エンコーディング。

デフォルト値: PlainText。無効な値は PlainText として扱われます。

ECS インスタンス上でコマンドを実行するためのユーザー名。値の長さは 255 文字を超えることはできません。

• Linux ECS インスタンスの場合、コマンドはデフォルトでルートユーザーとして実行されます。

• Windows ECS インスタンスの場合、コマンドはデフォルトで System ユーザーとして実行されます。

インスタンス上に存在する別のユーザーを指定してコマンドを実行することもできます。一般ユーザとしてクラウドアシスタントコマンドを実行する方が安全です。詳細については、「一般ユーザがクラウドアシスタントコマンドを実行するように設定する」をご参照ください。

Windows インスタンス上でコマンドを実行するユーザーのパスワードの名前。値の長さは 255 文字を超えることはできません。

Windows インスタンス上でデフォルト以外のユーザー (System) としてコマンドを実行したい場合は、Username とこのパラメーターの両方を指定する必要があります。パスワード漏洩のリスクを軽減するため、プレーンテキストパスワードを運用管理のパラメーターリポジトリに保存し、ここではパスワード名のみを渡してください。詳細については、「暗号化パラメーター」および「一般ユーザがクラウドアシスタントコマンドを実行するための設定項目」をご参照ください。

コンテナ ID。64 ビットの 16 進数文字列のみがサポートされています。docker://、containerd://、または cri-o:// プレフィックスを使用して、コンテナランタイムを明示的に指定できます。

注意事項:

• このパラメーターが指定されている場合、クラウドアシスタントはインスタンス上の指定されたコンテナ内でスクリプトを実行します。

• このパラメーターが指定されている場合、コマンドはクラウドアシスタントエージェントバージョン 2.2.3.344 以降の Linux インスタンス上でのみ実行できます。

• このパラメーターが指定されている場合、Username および WorkingDir パラメーターは効果がありません。コマンドは、コンテナのデフォルトの作業ディレクトリでデフォルトのコンテナユーザーとしてのみ実行されます。詳細については、「クラウドアシスタントを使用してコンテナ内でコマンドを実行する」をご参照ください。

コンテナ名。

注意事項:

• このパラメーターが指定されている場合、クラウドアシスタントはインスタンス上の指定されたコンテナ内でスクリプトを実行します。

• このパラメーターが指定されている場合、コマンドはクラウドアシスタントエージェントバージョン 2.2.3.344 以降の Linux インスタンス上でのみ実行できます。

• このパラメーターが指定されている場合、Username および WorkingDir パラメーターは効果がありません。コマンドは、コンテナのデフォルトの作業ディレクトリでデフォルトのコンテナユーザーとしてのみ実行されます。詳細については、「クラウドアシスタントを使用してコンテナ内でコマンドを実行する」をご参照ください。

リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken には ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。

コマンド実行出力の OSS 配信構成。

• 形式: oss://${BucketName}/${Prefix}。ここで ${BucketName} は送信先の OSS バケットの名前、${Prefix} は配信用のディレクトリプレフィックスです。

タスクを停止するモード（手動停止またはタイムアウトによる中断）。有効な値:

• Process: 現在のスクリプトプロセスを停止します。

• ProcessTree: 現在のプロセスツリー（スクリプトプロセスとそのプロセスが作成したすべての子プロセスのコレクション）を停止します。

スクリプト実行のブートストラッププログラム。値の長さは 1 KB を超えることはできません。