地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。

命令執行的資源組 ID，當指定該參數時：

• InstanceId 對應的 ECS 實例必須屬于該資源組。

• 支持通過指定該參數篩選出對應的命令執行結果（通過調用 DescribeInvocations 或 DescribeInvocationResults ）。

命令 ID。您可以通過接口 DescribeCommands 查詢所有可用的 CommandId。

設置命令執行的方式。取值范圍：

• Once：立即執行命令。
• Period：定時執行命令。當該參數取值為Period時，必須同時指定Frequency參數。
• NextRebootOnly：當實例下一次啟動時，自動執行命令。
• EveryReboot：實例每一次啟動都將自動執行命令。

默認值：

• 當不指定Frequency參數時，默認值為Once。
• 當指定Frequency參數時，無論是否已設置了該參數值，都將按照Period處理。

注意事項：

• 您可以調用 StopInvocation 停止待執行的命令或定時執行的命令。
• 當該參數取值Period或者EveryReboot時，您可以調用 DescribeInvocationResults ，然后指定IncludeHistory=true查看命令定時執行的歷史記錄。

定時執行命令的執行時間。目前支持三種定時執行方式：固定時間間隔執行（基于 Rate 表達式）、僅在指定時間執行一次、基于時鐘定時執行（基于 Cron 表達式）。

• 固定時間間隔執行：基于 Rate 表達式，按照設置的時間間隔執行命令。時間間隔支持按秒（s） 、分鐘（m） 、小時（h）和天（d）來選擇，適用于在固定時間間隔執行任務的場景。格式為rate(<執行間隔數值><執行間隔單位>)，例如 5 分鐘執行一次，格式為rate(5m)。使用固定時間間隔執行有以下限制：

  • 設置的時間間隔不大于 7 天、不小于 60 秒，且需大于定時任務的超時時間。
  • 執行間隔只基于固定頻率，與任務實際執行需要的時間無關。例如設置每 5 分鐘執行一次命令，任務需要 2 分鐘執行完成，則在任務完成 3 分鐘后繼續執行下一輪。
  • 創建任務時不會立即執行。例如設置每 5 分鐘執行一次命令，創建任務時不會立即執行一次命令，而是在任務創建完成后的 5 分鐘后開始執行。

• 僅在指定時間執行一次：按照設置的時區和執行時間點執行一次命令。格式為at(yyyy-MM-dd HH:mm:ss <時區>)，即at(年-月-日 時:分:秒 <時區>)。如果不指定時區，默認為 UTC 時區。時區支持以下三種形式：

  • 時區全稱： 例如Asia/Shanghai（中國/上海時間）、America/Los_Angeles（美國/洛杉磯時間）等。
  • 時區相對于格林威治時間的偏移量： 例如GMT+8:00（東八區）、GMT-7:00（西七區）等。使用 GMT 格式時，小時位不支持添加前導零。
  • 時區縮寫： 僅支持 UTC（協調世界時間）。

  如果指定在中國/上海時間 2022 年 06 月 06 日 13 時 15 分 30 秒執行一次，格式為：at(2022-06-06 13:15:30 Asia/Shanghai)；如果指定在西七區 2022 年 06 月 06 日 13 時 15 分 30 秒執行一次，格式為：at(2022-06-06 13:15:30 GMT-7:00)。

• 基于時鐘定時執行（基于 Cron 表達式）：基于 Cron 表達式，按照設置的定時任務執行命令。格式為<秒> <分鐘> <小時> <日期> <月份> <星期> <年份（可選）> <時區>，即<Cron 表達式> <時區>。在指定的時區下，根據 Cron 表達式推算定時任務執行時間并執行。若不指定時區，默認為執行定時任務實例的系統內部時區。關于 Cron 表達式的更多信息，請參見 Cron 表達式。時區支持以下三種形式：

  • 時區全稱： 例如Asia/Shanghai（中國/上海時間）、America/Los_Angeles（美國/洛杉磯時間）等。

  • 時區相對于格林威治時間的偏移量： 例如GMT+8:00（東八區）、GMT-7:00（西七區）等。使用 GMT 格式時，小時位不支持添加前導零。

  • 時區縮寫： 僅支持 UTC（協調世界時間）。 例如，在中國/上海時間，2022 年每天上午 10:15 執行一次命令，格式為0 15 10 ? * * 2022 Asia/Shanghai；在東八區時間，2022 年每天上午 10:00 到 11:30 每隔半小時執行，格式為0 0/30 10-11 * * ? 2022 GMT+8:00；在 UTC 時間，從 2022 年開始，每隔兩年的 10 月每天下午 14:00 到下午 14:55 時間段內每隔 5 分鐘執行，格式為0 0/5 14 * 10 ? 2022/2 UTC。

  說明 設置的最小時間間隔需大于或等于定時任務的超時時間，且不小于 10 秒。

啟用自定義參數功能時，執行命令時傳入的自定義參數的鍵值對。自定義參數的個數范圍為 0~10。

• Map 的鍵不允許為空字符串，最多支持 64 個字符。
• Map 的值允許為空字符串。
• 自定義參數與原始命令內容在 Base64 編碼后，綜合長度不能超過 18 KB。
• 設置的自定義參數名集合必須為創建命令時定義的參數集的子集。對于未傳入的參數，您可以使用空字符串代替。

您可以取消設置該參數從而禁用自定義參數。

在 ECS 實例中執行命令的用戶名稱。長度不得超過 255 個字符。

• Linux 系統的 ECS 實例，默認以 root 用戶執行命令。
• Windows 系統的 ECS 實例，默認以 System 用戶執行命令。

您也可以指定實例中已存在的其他用戶執行命令，以普通用戶執行云助手命令更加安全。更多信息，請參見設置普通用戶執行云助手命令。

在 Windows 實例中執行命令的用戶的密碼名稱。長度不得超過 255 個字符。

當您希望以非默認用戶（System）在 Windows 實例中執行命令時，需要同時傳入Username和該參數。為降低密碼泄露的風險，需要將密碼明文托管在系統運維管理的參數倉庫中，此處僅傳入密碼的名稱。更多信息，請參見加密參數以及設置普通用戶執行云助手命令。

需要執行命令的實例列表，最多能指定 100 臺實例 ID。N 的取值范圍為 1~100。

您也可以在配額中心申請提升配額（配額名稱為命令執行支持實例上限數）。

容器 ID。僅支持 64 位 16 進制字符串。支持使用docker://、containerd://或者cri-o://前綴來表示指定的容器運行時。

注意事項：

• 如果指定了該參數，云助手將在實例的指定容器內執行腳本。

• 如果指定了該參數，僅支持在云助手 Agent 版本不低于 2.2.3.344 的 Linux 實例內運行。

  • 查看云助手 Agent 版本的具體操作，請參見安裝云助手 Agent 。
  • 升級云助手 Agent 版本的具體操作，請參見升級或禁止升級云助手 Agent。

• 如果指定了該參數，本接口中已指定的Username參數和 CreateCommand 中指定的WorkingDir參數將不會生效。僅支持通過容器默認用戶在容器的默認工作目錄下執行命令。更多信息，請參見使用云助手在容器內執行命令。

• 如果指定了該參數，在 Linux 容器中只支持執行 Shell 腳本，不支持在腳本開頭使用類似#!/usr/bin/python命令的形式指定腳本內容的解釋器。更多信息，請參見使用云助手在容器內執行命令。

容器名稱。

注意事項：

• 如果指定了該參數，云助手將在實例的指定容器內執行腳本。

• 如果指定了該參數，僅支持在云助手 Agent 版本不低于 2.2.3.344 的 Linux 實例內運行。

  • 查看云助手 Agent 版本的具體操作，請參見安裝云助手 Agent 。
  • 升級云助手 Agent 版本的具體操作，請參見升級或禁止升級云助手 Agent。

• 如果指定了該參數，本接口中已指定的Username參數和 CreateCommand 中指定的WorkingDir參數將不會生效。僅支持通過容器默認用戶在容器的默認工作目錄下執行命令。更多信息，請參見使用云助手在容器內執行命令。

• 如果指定了該參數，在 Linux 容器中只支持執行 Shell 腳本，不支持在腳本開頭使用類似#!/usr/bin/python命令的形式指定腳本內容的解釋器。更多信息，請參見使用云助手在容器內執行命令。

執行命令的超時時間，單位：秒。

• 該值不能小于 10 秒。

• 當因為進程原因、缺失模塊、缺失云助手 Agent 等原因無法運行命令時，會出現超時現象。超時后，會強制終止命令進程。

• 若不設置該值，會采用創建命令時指定的超時時間。

• 該值只會作為該次命令執行的超時時間，不會改變命令本身的超時時間。

標簽列表。

保證請求冪等性。從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符，且不能超過 64 個字符。更多詳情，請參見如何保證冪等性。

用于篩選實例的標簽列表。可以在不指定 InstanceId 的情況下，向具有相同標簽的實例批量執行命令。

停止任務（手動停止或執行超時打斷）時的模式。可能值：

• Process：停止當前腳本進程。
• ProcessTree：停止當前進程樹（腳本進程以及它創建的所有子進程的集合）。

腳本執行的引導程序。長度不能超過 1 KB。