:RunCommand

実行する操作です。 値をRunCommandに設定します。

インスタンスが配置されているリージョンのID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

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

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

コマンドの言語タイプ。 設定可能な値は以下のとおりです。

• RunBatScript: バッチコマンド (Windowsインスタンスに適用可能)
• RunPowerShellScript: PowerShellコマンド (Windowsインスタンスに適用可能)
• RunShellScript: シェルコマンド (Linuxインスタンスに適用可能)

コマンドの内容。 コマンドの内容は、平文またはBase64-encodedです。 次の项目に注意してください。

• Base64-encodedコマンドの内容は16 KBを超えることはできません。
• If the command content is Base64-encoded, set ContentEncoding to Base64.
• EnableParameterをtrueに設定すると、カスタムパラメーター機能が有効になり、次のルールに基づいてカスタムパラメーターを設定できます。
  • カスタムパラメーターを {{}} 形式で定義します。 Within {{}}, the spaces and line feeds before and after the parameter names are ignored.
  • The number of custom parameters cannot exceed 20.
  • カスタムパラメーター名には、英数字、アンダースコア (_) 、およびハイフン (-) のみを使用できます。 名前は大文字と小文字が区別されません。
  • 各カスタムパラメーター名の長さは64バイトを超えることはできません。

ECSインスタンス上のコマンドの作業ディレクトリ。

デフォルト値：

• Linuxインスタンス: 管理者 (ルートユーザー) のホームディレクトリ (/root) 。
• Windowsインスタンス: Cloud Assistantクライアントプロセスが存在するディレクトリ (C:\Windows\System32など) 。

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

A timeout error occurs when a command cannot be run because the process slows down or because a specific module or the Cloud Assistant client does not exist. 実行がタイムアウトすると, コマンド処理が強制終了されます。

デフォルト値: 60。

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

規定値: false

コマンドの実行モード。 設定可能な値は以下のとおりです。

• Once: コマンドはすぐに実行されます。
• Period: コマンドは定期的に実行されます。 このパラメーターをPeriodに設定した場合、Timedをtrueに設定し、Frequencyを指定する必要があります。
• NextRebootOnly: コマンドは、次回インスタンスの起動時に自動的に実行されます。
• EveryReboot: インスタンスが起動するたびにコマンドが自動的に実行されます。

デフォルト値：

• Timedがfalseに設定され、Frequencyが指定されていない場合、RepeatModeのデフォルト値はOnceです。
• Timedがtrueに設定され、Frequencyが指定されている場合、RepeatModeが指定されているかどうかに関係なく、PeriodがRepeatModeの値として使用されます。

次の项目に注意してください。

• このパラメーターがPeriod、NextRebootOnly、またはEveryRebootに設定されている場合、StopInvocation操作を呼び出して、コマンドの保留中または繰り返し実行を停止できます。
• このパラメーターをPeriodまたはEveryRebootに設定すると、DescribeInvocationResults操作を呼び出し、IncludeHistoryをtrueに設定して、繰り返し実行の履歴結果を表示できます。

コマンドを定期的に実行するかどうかを指定します。 設定可能な値は以下のとおりです。

• true: Frequencyで指定されたスケジュールでコマンドを実行します。 各実行の結果は次の実行に影響しません。
• false: コマンドを1回だけ実行します。

規定値: false

コマンドの繰り返し実行が行われるスケジュール。

次の项目に注意してください。

• The interval between two consecutive executions must be 10 seconds or longer. The minimum interval cannot be less than the timeout period of the execution. 実行のタイムアウト期間は、操作のtimeoutパラメーターで指定します。
• Timedをtrueに設定する場合は、このパラメーターを指定する必要があります。
• Set the value of this parameter to a cron expression. 詳細については、「Cron式」をご参照ください。

コマンドにカスタムパラメータを含めることができるときに渡されるカスタムパラメータのキーと値のペア。 たとえば、コマンドの内容がecho {{name}} の場合です。 Parameterパラメーターを使用して、{"name":"Jack"} キーと値のペアを渡すことができます。 The name key of the custom parameter is automatically replaced by the paired Jack value to generate a new command. その結果、echo Jackコマンドが実際に実行される。

カスタムパラメータの数: 0〜10。 次の项目に注意してください。

• キーは空の文字列にすることはできません。長さは最大64文字です。
• 値は空の文字列にすることができます。
• カスタムパラメーターと元のコマンドコンテンツをBase64でエンコードした後、合計サイズは16 KBを超えることはできません。
• Parametersの値で指定されたカスタムパラメーター名は、コマンドの作成時に指定されたカスタムパラメーターにすべて含まれている必要があります。 空の文字列を使用して、渡されないパラメーターを表すことができます。

このパラメーターはデフォルトで空となります。 このパラメーターを空のままにして、カスタムパラメーター機能を無効にできます。

実行後にコマンドを保持するかどうかを指定します。 設定可能な値は以下のとおりです。

• true: コマンドは保持されます。 コマンドを再度実行するには、InvokeCommand操作を呼び出します。 保持されたコマンドは、Cloud Assistantコマンドのクォータに含まれます。
• false: コマンドは保持されません。 このコマンドは実行後に自動的に削除され、Cloud Assistantコマンドのクォータには含まれません。

規定値: false

コマンドコンテンツ (CommandContent) のエンコードモード。 有効な値は大文字と小文字を区別しません。 設定可能な値は以下のとおりです。

• PlainText: コマンドの内容はエンコードされていません。
• Base64: コマンドの内容がBase64-encodedです。

デフォルト値: PlainText。 このパラメーターの指定された値が無効な場合、デフォルトではPlainTextが使用されます。

ECSインスタンスでコマンドを実行するために使用されるユーザー名。

• Linuxインスタンスの場合、rootユーザーが使用されます。
• Windowsインスタンスの場合、システムユーザーが使用されます。

ECSインスタンスに既に存在する他のユーザーを指定してコマンドを実行することもできます。 通常のユーザーとしてCloud Assistantコマンドを実行する方が安全です。 詳細については、「Cloud Assistantコマンドを実行するための通常ユーザーの設定」をご参照ください。

Windowsインスタンスでコマンドを実行するために使用されるパスワードの名前。

既定のシステムユーザー以外のユーザー名を使用してWindowsインスタンスでコマンドを実行する場合は、WindowsPasswordNameパラメーターとusernameパラメーターの両方を指定する必要があります。 The password is hosted in plaintext in the parameter repository of Operation Orchestration Service (OOS) to mitigate the risk of password leaks. WindowsPasswordNameパラメーターを使用して、パスワードの名前のみが渡されます。 詳細については、「パラメーターの暗号化」および「Cloud Assistantコマンドを実行するための通常ユーザーの設定」をご参照ください。

コマンドを実行するインスタンスNのID。 Nの有効値: 1 ~ 50。

複数のインスタンスが指定され、そのうちの1つがコマンドの実行条件を満たさない場合、呼び出しは失敗し、条件を満たすインスタンスのIDを指定する必要があります。

リクエストの ID です。

コマンドのID。

実行のID。