Elastic Compute Service:InvokeCommand

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

コマンドを実行するリソースグループの ID。このパラメーターを指定する場合:

• InstanceId で指定された ECS インスタンスがデフォルトのリソースグループにない場合、そのインスタンスはこのリソースグループに属している必要があります。

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

コマンド ID。 DescribeCommands を呼び出して、利用可能なすべてのコマンド ID を照会できます。

コマンドの実行方法を指定します。有効な値:

• 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+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 式」を参照してください。タイムゾーンは次の 3 つの形式をサポートしています:

  • 完全なタイムゾーン名: たとえば、Asia/Shanghai (中国/上海時間) や America/Los_Angeles (米国/ロサンゼルス時間) など。

  • グリニッジ標準時からのタイムゾーンオフセット: たとえば、GMT+8:00 (UTC+8) や GMT-7:00 (UTC-7) など。GMT 形式を使用する場合、時間の値に先行ゼロはサポートされていません。

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

  説明

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

カスタムパラメーター機能が有効な場合に渡すカスタムパラメーターのキーと値のペア。カスタムパラメーターの数は 0 から 10 の範囲です。

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

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

• Base64 エンコーディング後、カスタムパラメーターと元のコマンドコンテンツの合計長は 24 KB を超えることはできません。

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

カスタムパラメーターを無効にするには、このパラメーターの設定を解除します。

ECS インスタンスでコマンドを実行するために使用されるユーザー名。値の長さは最大 255 文字です。

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

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

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

Windows インスタンスでコマンドを実行するユーザーが使用するパスワードの名前。値の長さは最大 255 文字です。

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

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

注意事項:

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

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

  • クラウドアシスタントエージェントのバージョンを表示するには、「クラウドアシスタントエージェントのインストール」を参照してください。

  • クラウドアシスタントエージェントのバージョンをスペックアップするには、「クラウドアシスタントエージェントのスペックアップまたはスペックアップの無効化」を参照してください。

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

• このパラメーターを指定すると、Linux コンテナではシェルスクリプトのみを実行できます。スクリプトの先頭に #!/usr/bin/python などの形式を使用してインタープリターを指定することはできません。詳細については、「クラウドアシスタントを使用したコンテナ内でのコマンドの実行」を参照してください。

コンテナ名。

注意事項:

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

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

  • クラウドアシスタントエージェントのバージョンを表示するには、「クラウドアシスタントエージェントのインストール」を参照してください。

  • クラウドアシスタントエージェントのバージョンをスペックアップするには、「クラウドアシスタントエージェントのスペックアップまたはスペックアップの無効化」を参照してください。

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

• このパラメーターを指定すると、Linux コンテナではシェルスクリプトのみを実行できます。スクリプトの先頭に #!/usr/bin/python などの形式を使用してインタープリターを指定することはできません。詳細については、「クラウドアシスタントを使用したコンテナ内でのコマンドの実行」を参照してください。

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

• 値は 10 秒以上である必要があります。

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

• この値を設定しない場合、コマンドの作成時に指定されたタイムアウト期間が使用されます。

• この値は現在のコマンド実行にのみ適用され、コマンド自体のタイムアウト期間は変更されません。

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

タスクが停止されるモード (手動で停止されるか、タイムアウトにより中断されるか)。有効な値:

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

• ProcessTree: 現在のプロセスツリー (スクリプトプロセスとそれが作成したすべての子プロセス) を停止します。

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

ECS インスタンスでコマンドを実行するディレクトリ。値の長さは最大 200 文字です。

• この値を設定しない場合、コマンドの作成時に指定された作業ディレクトリが使用されます。

• この値は現在のコマンド実行にのみ適用され、コマンド自体の作業ディレクトリは変更されません。

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

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