RunCommand_云服务器 ECS_API文档

该接口为异步接口，当前请求发送成功后，您可以通过返回的命令 ID 或命令执行 ID 调用 DescribeInvocations 或者 DescribeInvocationResults 查询执行结果。

使用须知

• 目标实例的状态为运行中（Running），您可以调用 DescribeInstances 查询。
• 目标实例已经预先安装云助手 Agent，您可以通过 InstallCloudAssistant 进行安装，并通过 DescribeCloudAssistantStatus 查询安装状态。
  说明 2017 年 12 月 01 日之后使用公共镜像创建的 ECS 实例，默认预装了云助手 Agent。
• 执行 PowerShell 类型的命令时，您需要确保目标 ECS 实例的 Windows 操作系统已经配置了 PowerShell 模块。

注意事项

• 在一个地域下，您最多可以保有 500～50,000 条云助手命令，您也可以申请提升配额，请参见配额管理。

• 云助手 Agent 版本需要不低于以下对应的版本才能支持定时任务的新特性（固定时间间隔执行、仅在指定时间执行一次、基于 Cron 表达式定时执行时指定年份或时区）。如果结果返回ClientNeedUpgrade错误码，请参见升级或禁止升级云助手 Agent，将客户端更新至最新版本。

  - Linux：2.2.3.282。
  - Windows：2.1.3.282。
  

• 当您基于 Cron 表达式执行定时任务且指定了时区，时钟定时执行时间设置基准为您指定的时区；当您没有指定时区时，时钟定时执行时间设置基准为 ECS 实例内的系统时区，且执行时间以实例的系统时间为准。请确保 ECS 实例的时间或者时区与您预期的时间一致。关于时区的更多信息，请参见设置 Linux 实例时区和 NTP 服务或设置 Windows 实例 NTP 服务。

使用建议

• 超时设置：您可以通过指定参数Timeout为命令设置在 ECS 实例中执行时最大的超时时间，命令执行超时后，云助手 Agent 会强制终止进程。
  • 单次执行超时后，命令的执行状态（ InvokeRecordStatus ）变为执行失败（Failed）。
  • 定时执行的超时时间对每一次执行记录均有效，上次执行超时不影响下一次执行。某次执行超时后，执行状态（ InvokeRecordStatus ）变为执行失败（Failed）。
• 执行失败：命令可能会因为目标实例的状态异常、网络异常或云助手 Agent 异常而出现无法执行的情况，无法执行时不会生成执行信息。更多信息，请参见执行失败常见错误及修复建议。
• 自定义参数：EnableParameter=true时会启用自定义参数功能。在设置CommandContent时可以通过{{parameter}}的形式表示自定义参数，并在运行命令时，传入自定义参数键值对。