InvokeCommand
可以指定CommandId、InstanceId、ResourceGroupId等参数,为一台或多台ECS实例触发一条云助手命令
服务地址:
华东1 金融云
输入参数
只看必填
RegionId地域ID
ResourceGroupId命令执行的资源组ID
CommandId命令ID
RepeatMode设置命令执行的方式
Timed>该参数已废弃
请选择布尔值
Frequency定时执行命令的执行时间
Parameters启用自定义参数功能时
Username在ECS实例中执行命令的用户名称
WindowsPasswordName在Windows实例中执行命令的用户的...
InstanceId需要执行命令的实例列表
0需要执行命令的实例ID
ContainerId容器ID
ContainerName容器名称
Timeout执行命令的超时时间
Tag标签列表
0标签列表
Key命令执行的标签键
Value命令执行的标签值
ClientToken保证请求幂等性
ResourceTag用于筛选实例的标签列表
0用于筛选实例的标签
Key用于筛选实例的标签键
Value用于筛选实例的标签值
TerminationMode停止任务(手动停止或执行超时打断)时的模式
Launcher脚本执行的引导程序
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 对目标 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 进制字符串。支持使用docker://containerd://或者cri-o://前缀来表示指定的容器运行时。展开详情

示例值:ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
ContainerNamestring

容器名称。展开详情

示例值:test-container
Timeoutinteger<int64>

执行命令的超时时间,单位:秒。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:60
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****
变更历史
变更时间变更内容概要操作
2024-10-28
变更错误码403
2024-08-01
变更错误码403
新增请求参数Launcher
2024-05-14
变更错误码404
新增请求参数TerminationMode
2024-04-12
变更请求参数InstanceId