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 を指定して、スケジュールされたコマンドの実行履歴を表示できます。

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

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

• 固定間隔での実行：レート式に基づき、指定された間隔でコマンドが実行されます。間隔は秒 (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 オフセット：GMT+8:00 (UTC+8) や GMT-7:00 (UTC-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 に UTC-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 オフセット：GMT+8:00 (UTC+8) や GMT-7:00 (UTC-7) など。GMT 形式を使用する場合、時間値の先頭のゼロはサポートされていません。

  • タイムゾーン略語：協定世界時 (UTC) のみがサポートされています。 たとえば、2022 年中毎日中国/上海時間の 10:15 に 1 回実行するには、0 15 10 ? * * 2022 Asia/Shanghai を使用します。2022 年中毎日 UTC+8 の 10:00 から 11:30 まで 30 分ごとに実行するには、0 0/30 10-11 * * ? 2022 GMT+8:00 を使用します。2022 年から 2 年ごとの 10 月の毎日協定世界時 (UTC) の 14:00 から 14:55 まで 5 分ごとに実行するには、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 とこのパラメーターの両方を指定する必要があります。パスワード漏洩のリスクを減らすために、プレーンテキストパスワードを CloudOps Orchestration サービスのパラメーターリポジトリに保存し、ここではパスワード名のみを渡します。詳細については、「暗号化パラメーター」および「クラウドアシスタントコマンドを実行するための一般ユーザの設定」を参照してください。

コンテナ 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 を超えることはできません。