- 地域
- 询价
- 实例
- 镜像
- 块存储
- 快照
- 网络
- 弹性网卡
- 前缀列表
- 端口列表
- 安全组
- 密钥对
- 启动模板
- 弹性供应组
- 部署集
- 资源保障
- 预留实例券
- 存储容量单位包
- 云助手
- 创建并执行云助手命令RunCommand
- 创建云助手命令CreateCommand
- 执行云助手命令InvokeCommand
- 查询云助手命令的执行信息列表DescribeInvocations
- 查询云助手命令执行结果DescribeInvocationResults
- 修改云助手命令的执行属性ModifyInvocationAttribute
- 停止执行云助手命令StopInvocation
- 查询已创建的云助手命令DescribeCommands
- 修改云助手命令ModifyCommand
- 删除一条云助手命令DeleteCommand
- 上传本地文件到ECS实例SendFile
- 查询云助手下发文件列表及状态DescribeSendFileResults
- 查询云助手安装状态DescribeCloudAssistantStatus
- 为实例安装云助手AgentInstallCloudAssistant
- 开始终端会话StartTerminalSession
- 关闭终端会话EndTerminalSession
- 查看Session Manager会话历史记录DescribeTerminalSessions
- 修改云助手服务配置ModifyCloudAssistantSettings
- 查询云助手服务配置DescribeCloudAssistantSettings
- 创建一个激活码CreateActivation
- 查询激活码的使用情况DescribeActivations
- 手动禁用指定的激活码DisableActivation
- 删除一个未被使用的激活码DeleteActivation
- 获取托管实例DescribeManagedInstances
- 修改托管实例ModifyManagedInstance
- 注销托管实例DeregisterManagedInstance
- 查询实例中云助手插件的状态ListPluginStatus
- 系统事件
- 资源诊断
- 运维与监控
- 标签与资源组
- 专有宿主机
- 高性能集群
- 任务
- Deprecated
接口说明
-
对目标 ECS 实例有如下限制。选择了多台 ECS 实例后,若其中某台实例不满足执行条件,您需要重新调用接口。
-
状态必须为运行中(
Running
),您可以调用 DescribeInstances 查询。 -
已预先安装云助手 Agent。
-
执行类型为 PowerShell 的命令时,实例必须已经配置了 PowerShell 模块。
-
-
单次执行:只执行一次命令。
-
定时执行:
- 根据参数 Frequency 指定的时间频率定时执行,上次的执行结果不会对下一次执行产生任何影响。
- 当您基于 Cron 表达式执行定时任务且指定了时区,时钟定时执行时间设置基准为您指定的时区;当您没有指定时区时,时钟定时执行时间设置基准为 ECS 实例内的系统时区,且执行时间以实例的系统时间为准。请确保 ECS 实例的时间或者时区与您预期的时间一致。更多关于时区的详情,请参见管理时间同步服务。
云助手 Agent 版本不低于以下对应的版本才能支持定时任务的新特性(固定时间间隔执行、仅在指定时间执行一次、基于 Cron 表达式定时执行时指定年份或时区)。如果结果返回 ClientNeedUpgrade 错误码,请参见升级或禁止升级云助手 Agent,将客户端更新至最新版本。
- Linux:2.2.3.282。
- Windows:2.1.3.282。
-
命令可能会因为目标实例的状态异常、网络异常或云助手 Agent 异常而出现无法执行的情况,无法执行时不会生成执行信息。更多信息,请参见执行失败常见错误及修复建议。
-
当您创建命令时启用了自定义参数功能,需要在执行命令时传入自定义参数(
Parameters
)。 -
建议您先调用 DescribeCloudAssistantStatus 查询实例的云助手状态,当 CloudAssistantStatus 为 true 时再执行命令,尤其对于新购实例。
请求参数
字段名称 | 字段详情 |
---|---|
RegionIdstring | 地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
ResourceGroupIdstring | 命令执行的资源组 ID,当指定该参数时:展开详情 示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSecurityGroups |
CommandIdstring | 命令 ID。您可以通过接口 DescribeCommands 查询所有可用的 CommandId。 展开详情 示例值:c-e996287206324975b5fbe1d****参考取值来源: RunCommand CreateCommand DescribeCommands |
RepeatModestring | 设置命令执行的方式。取值范围:展开详情 示例值:Once |
Timedboolean | 说明
该参数已废弃,传入该参数不会生效。
示例值:true |
Frequencystring | 定时执行命令的执行时间。目前支持三种定时执行方式:固定时间间隔执行(基于 Rate 表达式)、仅在指定时间执行一次、基于时钟定时执行(基于 Cron 表达式)。展开详情 示例值:0 */20 * * * ? |
Parametersobject | 启用自定义参数功能时,执行命令时传入的自定义参数的键值对。自定义参数的个数范围为 0~10。展开详情 示例值:{"name":"Jack", "accessKey":"LTAI************"} |
Usernamestring | 在 ECS 实例中执行命令的用户名称。长度不得超过 255 个字符。展开详情 示例值:test |
WindowsPasswordNamestring | 在 Windows 实例中执行命令的用户的密码名称。长度不得超过 255 个字符。展开详情 示例值:axtSecretPassword |
InstanceIdarray<string> | 需要执行命令的实例列表,最多能指定 100 台实例 ID。N 的取值范围为 1~100。展开详情 示例值:i-bp185dy2o3o6n****子级条数 <= 501 |
ContainerIdstring | 容器 ID。仅支持 64 位 16 进制字符串。支持使用 示例值:ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
ContainerNamestring | 容器名称。展开详情 示例值:test-container |
Timeoutinteger<int64> | |
Tagarray<object> | 标签列表。 子级条数 <= 21 |
ClientTokenstring | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性。 示例值:123e4567-e89b-12d3-a456-42665544**** |
ResourceTagarray<object> | 用于筛选实例的标签列表。可以在不指定 InstanceId 的情况下,向具有相同标签的实例批量执行命令。 子级条数 <= 11 |
TerminationModestring | 停止任务(手动停止或执行超时打断)时的模式。可能值:展开详情 示例值:ProcessTree |
Launcherstring | 脚本执行的引导程序。长度不能超过 1 KB。 示例值:python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
返回参数
字段名称 | 字段详情 |
---|---|
InvokeIdstring | 命令执行 ID。 示例值:t-7d2a745b412b4601b2d47f6a768d**** |
RequestIdstring | 请求 ID。 示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |