Elastic Compute Service:RunCommand

リージョン ID。DescribeRegions API を呼び出して、Alibaba Cloud の最新のリージョン情報を照会できます。

コマンド実行のリソースグループ ID。このパラメーターを指定する場合、次のルールが適用されます。

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

• DescribeInvocations または DescribeInvocationResults API を呼び出すときに、このパラメーターを使用してコマンド実行結果をフィルターできます。

The ID of the region. You can call the DescribeRegions operation to query the latest Alibaba Cloud regions.

コマンドの名前。長さは最大 128 文字で、すべての文字セットをサポートします。

コマンドの説明。長さは最大 512 文字で、すべての文字セットをサポートします。

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

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

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

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

コマンドの内容。プレーンテキスト、または Base64 でエンコードして指定します。以下の点にご注意ください。

• Base64 でエンコードされたコマンド内容のサイズは、KeepCommand が true の場合は 18 KB、KeepCommand が false の場合は 24 KB に制限されます。

• コマンド内容が Base64 でエンコードされている場合は、ContentEncoding を Base64 に設定する必要があります。

• EnableParameter を true に設定すると、コマンド内容でカスタムパラメーター機能が有効になります。

  • {{}} 形式を使用してカスタムパラメーターを定義します。{{}} 内のパラメーター名の前後のスペースと改行は無視されます。

  • 最大 20 個のカスタムパラメーターを定義できます。

  • カスタムパラメーター名には、文字、数字、アンダースコア (_)、ハイフン (-) のみ使用できます。名前は大文字と小文字を区別せず、組み込み環境パラメーター用に予約されている acs:: で始めることはできません。

  • カスタムパラメーター名の長さは最大 64 バイトです。

• 組み込み環境パラメーターを使用できます。Cloud Assistant は、実行時にこれらを対応する値へ自動的に置き換えます。次の組み込み環境パラメーターがサポートされています。

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

  • {{ACS::AccountId}}：Alibaba Cloud アカウントの UID。

  • {{ACS::InstanceId}}：インスタンス ID。複数のインスタンスでこのパラメーターを使用するには、Cloud Assistant Agent のバージョンが Linux インスタンスでは 2.2.3.309 以降、Windows インスタンスでは 2.1.3.309 以降のバージョンが必要です。

    • Linux： 2.2.3.309

    • Windows： 2.1.3.309

  • {{ACS::InstanceName}}：インスタンス名。複数のインスタンスでこのパラメーターを使用するには、Cloud Assistant Agent のバージョンが Linux インスタンスでは 2.2.3.344 以降、Windows インスタンスでは 2.1.3.344 以降のバージョンが必要です。

    • Linux： 2.2.3.344

    • Windows： 2.1.3.344

  • {{ACS::InvokeId}}：呼び出し ID。このパラメーターを使用するには、Cloud Assistant Agent のバージョンが Linux インスタンスでは 2.2.3.309 以降、Windows インスタンスでは 2.1.3.309 以降のバージョンが必要です。

    • Linux： 2.2.3.309

    • Windows： 2.1.3.309

  • {{ACS::CommandId}}：コマンド ID。このパラメーターを使用するには、Cloud Assistant Agent のバージョンが Linux インスタンスでは 2.2.3.309 以降、Windows インスタンスでは 2.1.3.309 以降のバージョンが必要です。

    • Linux： 2.2.3.309

    • Windows： 2.1.3.309

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

デフォルト値：

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

• Windows インスタンスの場合、デフォルトは Cloud Assistant Agent プロセスのディレクトリ (C:\Windows\System32 など) です。

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

プロセス競合、モジュールの欠落、または Cloud Assistant Agent の無効化などの例外によりコマンドの実行に失敗した場合、タイムアウトによってコマンドプロセスが強制的に終了されます。

デフォルト値： 60。

コマンドでカスタムパラメーターを使用するかどうかを指定します。

デフォルト値： false。

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

• Once：コマンドはすぐに実行されます。

• Period：コマンドをスケジュールされたタスクとして実行します。このモードでは、Frequency パラメーターを指定する必要があります。

• NextRebootOnly：インスタンスが次回起動時にコマンドが自動的に実行されます。

• EveryReboot：インスタンスが起動するたびにコマンドが自動的に実行されます。

• DryRun：コマンドを実際に実行せずに、パラメーターと環境をチェックするドライランを実行します。

デフォルト値：

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

• Frequency が指定されている場合、このパラメーターは自動的に Period に設定されます。

注：

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

• このパラメーターを Period または EveryReboot に設定した場合、DescribeInvocationResults API を呼び出して IncludeHistory=true を設定すると、スケジュールされたコマンドの実行履歴レコードを照会できます。

コマンドのスケジュール。レート式、単発実行用の at 式、または cron 式を指定できます。

• 固定間隔の実行：レート式で定義された固定間隔でコマンドを実行します。間隔は秒 (s)、分 (m)、時間 (h)、または日 (d) で指定できます。この方法は、固定間隔で実行する必要があるタスクに適しています。フォーマットは rate(<value><unit>) です。たとえば、5 分ごとにコマンドを実行するには、rate(5m) を使用します。この方法には次の制限が適用されます。

  • 間隔は 60 秒〜7 日の範囲で、かつスケジュールされたタスクのタイムアウトよりも長く設定する必要があります。

  • 間隔は固定であり、前の実行の完了時点からではなく、開始時点からカウントされます。

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

• 単発実行：指定した時刻とタイムゾーンでコマンドを 1 回実行します。フォーマットは at(yyyy-MM-dd HH:mm:ss <time_zone>) です。タイムゾーンを指定しない場合、デフォルトでは UTC が使用されます。次のタイムゾーン形式がサポートされています。

  • 完全なタイムゾーン名 (例：Asia/Shanghai または America/Los_Angeles)。

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

  • タイムゾーンの略語。UTC のみサポートされています。

  例1：Asia/Shanghai タイムゾーンで 2022 年 6 月 6 日 13:15:30 にタスクを実行するには、at(2022-06-06 13:15:30 Asia/Shanghai) を使用します。例2：GMT-7:00 タイムゾーンで 2022 年 6 月 6 日 13:15:30 にタスクを実行するには、at(2022-06-06 13:15:30 GMT-7:00) を使用します。

• cron 式に基づく定期実行：cron 式で定義されたスケジュールに従ってコマンドを実行します。フォーマットは <second> <minute> <hour> <day_of_month> <month> <day_of_week> <year (optional)> <time_zone>、または <cron_expression> <time_zone> です。タスクは指定されたタイムゾーンの cron 式に基づいて実行されます。タイムゾーンを指定しない場合、デフォルトでは、タスクが実行されるインスタンスのシステムタイムゾーンが使用されます。cron 式の詳細については、「Cron 式」をご参照ください。次のタイムゾーン形式がサポートされています。

  • 完全なタイムゾーン名 (例：Asia/Shanghai または America/Los_Angeles)。

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

  • タイムゾーンの略語。UTC のみサポートされています。 たとえば、Asia/Shanghai タイムゾーンで 2022 年に毎日 10:15 にコマンドを実行するには、0 15 10 ? * * 2022 Asia/Shanghai を使用します。GMT+8:00 タイムゾーンで 2022 年に毎日 10:00 から 11:30 まで 30 分ごとにコマンドを実行するには、0 0/30 10-11 * * ? 2022 GMT+8:00 を使用します。UTC で 2022 年から 2 年ごとの 10 月に毎日 14:00 から 14:55 まで 5 分ごとにコマンドを実行するには、0 0/5 14 * 10 ? 2022/2 UTC を使用します。

  説明

  最小間隔は、スケジュールされたタスクのタイムアウト以上かつ 10 秒以上である必要があります。

カスタムパラメーターのキーと値のペア。たとえば、CommandContent が echo {{name}} の場合、Parameters を {"name":"田中"} に設定すると、コマンド echo 田中 が実行されます。

0〜10 個のキーと値のペアを指定できます。以下の点にご注意ください。

• キーを空の文字列にすることはできず、長さは最大 64 文字です。

• 値は空の文字列にできます。

• Base64 エンコード後、カスタムパラメーターと元のコマンド内容の合計サイズは、KeepCommand が true の場合は 18 KB、KeepCommand が false の場合は 24 KB に制限されます。

• 指定するカスタムパラメーター名のセットは、CommandContent で定義されたパラメーターのサブセットである必要があります。省略されたパラメーターの値は、デフォルトでは空の文字列になります。

デフォルト値は空です。これは、カスタムパラメーターが使用されないことを意味します。

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

• true：コマンドを保存します。保存したコマンドは、InvokeCommand を呼び出して再実行できます。保存されたコマンドは、Cloud Assistant のコマンドクォータにカウントされます。

• false：コマンドを保存しません。コマンドは実行後に削除され、クォータにはカウントされません。

デフォルト値： false。

コマンド内容 (CommandContent) のエンコードモード。有効な値 (大文字と小文字を区別しない)：

• PlainText：コマンド内容はエンコードされず、プレーンテキストとして送信されます。

• Base64：コマンド内容は Base64 でエンコードされます。

デフォルト値： PlainText。無効な値を指定すると、自動的に PlainText に設定されます。

ECS インスタンスでコマンドを実行するユーザーの名前。名前の長さは最大 255 文字です。

• Linux インスタンスのデフォルト： root。

• Windows インスタンスのデフォルト： System。

インスタンス上の別の既存のユーザーを指定してコマンドを実行できます。Cloud Assistant コマンドを標準ユーザーとして実行する方が安全です。詳細については、「Cloud Assistant コマンドを標準ユーザーとして実行する」をご参照ください。

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

Windows インスタンスでデフォルト以外のユーザーとしてコマンドを実行するには、Username と WindowsPasswordName の両方を指定する必要があります。パスワード漏洩のリスクを軽減するために、パスワードを OOS Parameter Store に保存し、そのパラメーター名をここで指定することを推奨します。詳細については、「暗号化パラメーター」および「Cloud Assistant コマンドを標準ユーザーとして実行する」をご参照ください。

コンテナの ID。ID は 64 ビットの 16 進文字列でなければなりません。docker://、containerd://、または cri-o:// プレフィックスを追加して、コンテナランタイムを明示的に指定できます。

注：

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

• このパラメーターは、Cloud Assistant Agent のバージョンが 2.2.3.344 以降の Linux インスタンスでのみサポートされています。

• このパラメーターを指定した場合、指定された Username および WorkingDir パラメーターは無視されます。コマンドは、コンテナのデフォルトユーザーによって、デフォルトの作業ディレクトリでのみ実行されます。詳細については、「Cloud Assistant を使用してコンテナでコマンドを実行する」をご参照ください。

コンテナの名前。

注：

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

• このパラメーターは、Cloud Assistant Agent のバージョンが 2.2.3.344 以降の Linux インスタンスでのみサポートされています。

• このパラメーターを指定した場合、指定された Username および WorkingDir パラメーターは無視されます。コマンドは、コンテナのデフォルトユーザーによって、デフォルトの作業ディレクトリでのみ実行されます。詳細については、「Cloud Assistant を使用してコンテナでコマンドを実行する」をご参照ください。

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

コマンド出力を OSS に配信するための設定です。

• フォーマット： oss://${BucketName}/${Prefix}。${BucketName} は宛先 OSS バケットの名前、${Prefix} は宛先プレフィックスです。

タスクが手動で停止された場合、またはタイムアウトした場合にタスクを停止するモード。有効な値：

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

• ProcessTree：現在のプロセスツリーを停止します。プロセスツリーには、現在のスクリプトプロセスとそのすべてのサブプロセスが含まれます。

スクリプトの実行に使用するランチャー。値の長さは最大 1 KB です。