Elastic Compute Service:InvokeCommand

コマンドのリージョン ID です。最新のリージョンリストを照会するには、DescribeRegions 操作を呼び出してください。

コマンド実行を割り当てるリソースグループの ID です。このパラメーターを設定する際は、以下の点にご注意ください。

• InstanceId.N で指定されたインスタンスは、指定されたリソースグループに属している必要があります。

• コマンド実行後、ResourceGroupId を設定して DescribeInvocations または DescribeInvocationResults 操作を呼び出すことで、指定されたリソースグループ内の実行結果を照会できます。

コマンドのリージョン ID です。最新のリージョンリストを照会するには、DescribeRegions 操作を呼び出してください。

コマンド ID です。利用可能なすべてのコマンド ID を照会するには、DescribeCommands 操作を呼び出してください。

コマンドの実行方法を指定します。有効な値は以下のとおりです。

• Once：すぐにコマンドを実行します。

• Period：スケジュールに基づいてコマンドを実行します。Period をこのパラメーターに設定する場合、Frequency パラメーターも構成する必要があります。

• NextRebootOnly：インスタンスが次回起動されたときにコマンドを実行します。

• EveryReboot：インスタンスが起動するたびにコマンドを実行します。

• DryRun：実際のリクエストを実行せずにドライランのみを実施するかどうかを指定します。コマンドは有効になりません。システムはリクエストパラメーター、インスタンスの実行環境、およびクラウドアシスタントエージェントの実行ステータスを含むリクエストをチェックします。

デフォルト値：

• Frequency を指定しない場合、デフォルト値は Once です。

• Frequency パラメーターを指定する場合、RepeatMode に Period が設定されているかどうかに関係なく、RepeatMode の値として Period が使用されます。

このプロパティを指定する際は、以下の点にご注意ください。

• 保留中またはスケジュールされたコマンドの実行を停止するには、StopInvocation 操作を呼び出すことができます。

• このパラメーターを Period または EveryReboot に設定する場合、IncludeHistory を true に設定して DescribeInvocationResults 操作を呼び出すことで、過去のスケジュール実行の結果を照会できます。

コマンドを実行するスケジュールです。コマンドを固定間隔で実行するためのレート式、特定の時刻に 1 回だけ実行するための指定、または cron 式に基づいて特定の時刻に実行するように構成できます。

• コマンドを固定間隔で実行するには、レート式を使用して間隔を指定します。秒、分、時間、日単位で間隔を指定できます。このオプションは、タスクを固定間隔で実行する必要があるシナリオに適しています。間隔は以下の形式で指定します：rate(<実行間隔の値><実行間隔の単位>)。たとえば、コマンドを 5 分ごとに実行するには、rate(5m) を指定します。間隔を指定する際は、以下の制限にご注意ください。

  • 間隔は 60 秒から 7 日の範囲で指定でき、ただし定期タスクのタイムアウト期間より長くする必要があります。

  • 間隔は、連続する 2 回の実行の間に経過する時間です。1 回のコマンド実行に必要な時間とは無関係です。たとえば、間隔を 5 分に設定し、コマンドの実行に毎回 2 分かかると仮定します。コマンドが実行されるたびに、システムは次の実行前に 3 分待機します。

  • タスクは作成直後に実行されません。たとえば、タスクの間隔を 5 分に設定した場合、タスクは作成から 5 分後に実行を開始します。

• コマンドを特定の時刻に 1 回だけ実行するには、時刻とタイムゾーンを指定します。時刻は at(yyyy-MM-dd HH:mm:ss <タイムゾーン>) 形式で指定します。これは at(年-月-日 時:分:秒 <タイムゾーン>) を意味します。タイムゾーンを指定しない場合、協定世界時 (UTC) タイムゾーンがデフォルトで使用されます。タイムゾーンは以下の形式で指定できます。

  • タイムゾーン名。例：Asia/Shanghai、America/Los_Angeles。

  • GMT からのオフセット。例：GMT+8:00 (UTC + 08:00)、GMT-7:00 (UTC - 07:00)。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 - 07:00) にコマンドを 1 回だけ実行するには、時刻を at(2022-06-06 13:15:30 GMT-7:00) に設定します。

• コマンドを特定の時刻に実行するには、cron 式を使用してスケジュールを定義します。スケジュールは <cron 式> <タイムゾーン> 形式で指定します。cron 式は <秒> <分> <時> <日の日付> <月> <曜日> <年 (省略可)> 形式です。システムは、指定された cron 式とタイムゾーンに基づいてコマンドの実行時刻を計算し、スケジュール通りにコマンドを実行します。タイムゾーンを指定しない場合、コマンドを実行するインスタンスのシステムタイムゾーンがデフォルトで使用されます。cron 式の詳細については、「cron 式」をご参照ください。タイムゾーンは以下の形式で指定できます。

  • タイムゾーン名。例：Asia/Shanghai、America/Los_Angeles。

  • GMT からのオフセット。例：GMT+8:00 (UTC + 08:00)、GMT-7:00 (UTC - 07:00)。GMT 形式を使用する場合、時刻の値に先行ゼロを付加することはできません。

  • タイムゾーンの略称。UTC のみがサポートされています。たとえば、2022 年中に毎日 10 時 15 分 00 秒 (上海時間) にコマンドを実行するには、スケジュールを 0 15 10 ? * * 2022 Asia/Shanghai に設定します。2022 年中に毎日 UTC + 08:00 で 10 時 00 分 00 秒から 11 時 30 分 00 秒の間、30 分ごとにコマンドを実行するには、スケジュールを 0 0/30 10-11 * * ? 2022 GMT+8:00 に設定します。2022 年から 2 年ごとの 10 月に、UTC で毎日 14 時 00 分 00 秒から 14 時 55 分 00 秒の間、5 分ごとにコマンドを実行するには、スケジュールを 0 0/5 14 * 10 ? 2022/2 UTC に設定します。

  **

  注記 最小間隔は 10 秒以上である必要があり、かつ定期実行のタイムアウト期間より短くすることはできません。

カスタムパラメーター機能を有効にした場合に渡すカスタムパラメーターのキーと値のペアです。最大 10 個のカスタムパラメーターを指定できます。

• Map コレクション内の各キーは空文字列であってはならず、最大 64 文字までです。

• Map コレクション内の各値は空文字列であっても構いません。

• カスタムパラメーターと元のコマンド内容を含む Base64 エンコーディング後のコマンドサイズは、18 KB を超えてはなりません。

• Parameters で指定するカスタムパラメーター名は、コマンド作成時に指定したカスタムパラメーター名に含まれている必要があります。指定されていないカスタムパラメーターは、空文字列で表すことができます。

カスタムパラメーター機能を無効にする場合は、このパラメーターを空のままにしてください。

ECS インスタンスでコマンドを実行する際に使用するユーザー名です。ユーザー名の長さは 255 文字を超えてはなりません。

• Linux インスタンスの場合、デフォルトで root ユーザーが使用されます。

• Windows インスタンスの場合、デフォルトで System ユーザーが使用されます。

コマンドを実行するために、インスタンス内にすでに存在する他のユーザー名を指定することもできます。セキュリティ上の理由から、クラウドアシスタントコマンドは一般ユーザとして実行することを推奨します。詳細については、「一般ユーザとしてクラウドアシスタントコマンドを実行する」をご参照ください。

Windows インスタンスでコマンドを実行する際に使用するパスワードの名前です。名前の長さは 255 文字を超えてはなりません。

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

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

以下の点にご注意ください。

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

• このパラメーターを指定すると、コマンドはクラウドアシスタントエージェント 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 秒未満にすることはできません。

• プロセスが遅延したり、特定のモジュールまたはクラウドアシスタントエージェントが存在しないためにコマンドが実行できない場合、タイムアウトエラーが発生します。指定されたタイムアウト期間が終了すると、コマンドプロセスは強制終了されます。

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

• このタイムアウト期間は、今回の実行にのみ適用されます。コマンドのタイムアウト期間は変更されません。

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

コマンド実行を手動で停止またはタイムアウトした際に、コマンドタスクを停止する方法を指定します。有効な値は以下のとおりです。

• Process：コマンドのプロセスを停止します。

• ProcessTree：コマンドのプロセスツリーを停止します。この場合、コマンドのプロセスとそのすべてのサブプロセスが停止されます。

スクリプト実行のランチャーです。値の長さは 1 KB を超えてはなりません。

ECS インスタンスでのコマンドの実行パスです。値の長さは最大 200 文字です。

• このパラメーターを指定しない場合、コマンド作成時に指定された実行パスが使用されます。

• この実行パスは今回のタスクにのみ適用されます。コマンドの実行パスは変更されません。

コマンド出力の OSS 配信構成です。

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