RunCommand_云助手_API参考_云服务器 ECS

接口说明

不同于通过CreateCommand和InvokeCommand执行命令，RunCommand只需一次调用即可完成命令的创建与执行。

调用该接口时，您需要注意：

目标实例的网络类型必须是专有网络VPC。
目标实例的状态必须为运行中（Running）。
目标实例必须预先安装云助手客户端（InstallCloudAssistant）。
执行类型为PowerShell的命令时，您需要确保目标ECS Windows实例已经配置了PowerShell模块。
周期执行的时间设置基准为UTC +0，且该时间以实例的系统时间为准。ECS实例的时间或者时区必须与您预期的时间一致。更多关于时区的详情，请参见设置Linux实例时区和NTP服务或设置Windows实例NTP服务。
您可以通过指定参数TimeOut为命令设置在ECS实例中执行时最大的超时时间，命令执行超时后，云助手客户端会强制终止进程。
- 单次执行超时后，命令的执行状态（InvokeRecordStatus）变为执行失败（Failed）。
- 周期执行的超时时间对每一次执行记录均有效，上次执行超时不影响下一次执行。某次执行超时后，执行状态（InvokeRecordStatus）变为执行失败（Failed）。
命令可能会因为目标实例的状态异常、网络异常或云助手客户端异常而出现无法执行的情况，无法执行时不会生成执行信息。
EnableParameter=true时会启用自定义参数功能。在设置CommandContent时可以通过{{parameter}}的形式表示自定义参数，并在运行命令时，传入自定义参数键值对。
在一个地域下，根据您的使用情况，最多可以保有100-10000条云助手命令，每天最多可以执行2000-200000条云助手命令。您可以通过DescribeAccountAttribute查询配额情况，也可以提交工单调整保有量配额和调用次数配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	RunCommand	系统规定参数。取值：RunCommand
CommandContent	String	是	ZWNobyAxMjM=	命令的明文内容或者Base64编码后的内容。命令内容Base64编码后不能超过16KB。指定参数`EnableParameter=true`可在命令内容中启用自定义参数功能：用`{{}}`包含的方式定义自定义参数，在`{{}}`内参数名前后的空格以及换行符会被忽略。自定义参数个数不能超过20个。自定义参数名允许a-zA-Z0-9-_的组合，不支持其余字符，参数名不区分大小写。单个自定义参数键不能超过64字节。
InstanceId.N	RepeatList	是	i-bp185dy2o3o6neg****	ECS实例ID列表。N的取值范围：1~50 若指定了多台实例后，其中某台实例不满足执行条件时，您都需要重新选择。
RegionId	String	是	cn-hangzhou	地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
Type	String	是	RunShellScript	运维命令的语言类型。取值范围： RunBatScript：适用于Windows实例的Bat命令。 RunPowerShellScript：适用于Windows实例的PowerShell命令。 RunShellScript：适用于Linux实例Shell命令。
Name	String	否	testName	命令名称。支持全字符集，长度不得超过128个字符。
Description	String	否	testDescription	命令描述。支持全字符集，长度不得超过512个字符。
WorkingDir	String	否	/home/	命令在ECS实例中的运行目录。默认值： Linux系统实例默认在管理员（root用户）的home目录下，即`/root`。 Windows系统实例默认在云助手客户端进程所在目录，例如`C:\Windows\System32`。
Timeout	Long	否	3600	执行命令的超时时间，单位为秒。当因为进程原因、缺失模块、缺失云助手客户端等原因无法运行命令时，会出现超时现象。超时后，会强制终止命令进程。默认值：60
EnableParameter	Boolean	否	false	命令中是否包含自定义参数。默认值：false
RepeatMode	String	否	Once	设置命令执行的方式。取值范围： Once：立即执行命令。 Period：定时执行命令。当该参数取值为`Period`时，必须同时指定`Timed=true`参数值以及`Frequency`参数。 NextRebootOnly：当实例下一次启动时，自动执行命令。 EveryReboot：实例每一次启动都将自动执行命令。默认值：当不指定`Timed=true`参数值以及`Frequency`参数时，默认值为`Once`。当指定`Timed=true`参数值以及`Frequency`参数时，无论是否已设置了该参数值，都将按照`Period`处理。注意事项：当该参数取值`Period`、`NextRebootOnly`或者`EveryReboot`时，您可以调用StopInvocation停止待执行的命令或周期执行的命令。当该参数取值`Period`或者`EveryReboot`时，您可以调用DescribeInvocationResults，然后指定`IncludeHistory=true`查看命令周期执行的历史记录。
Timed	Boolean	否	true	是否周期执行命令。取值范围： true：根据参数`Frequency`设置的时间频率定时执行。上次的执行结果不对下一次执行产生任何影响。 false：只执行一次。默认值：false
Frequency	String	否	0 /20 * * *	周期执行命令的执行周期。当参数`Timed`的值为`true`时，该参数为必选参数。两次周期执行的命令时间间隔不能低于10秒。该参数取值遵循Cron表达式，请参见设置定时执行命令。
Parameters	Json	否	{"name":"Jack", "accessKey":"LTAIdyvdIqaRY****"}	命令中包含自定义参数时，执行命令时传入的自定义参数的键值对。例如，命令内容为`echo {{name}}`，则可以通过`Parameter`参数传入键值对`{"name":"Jack"}`。自定义参数将自动替换变量值`name`，得到一条新的命令，实际执行的是`echo Jack`。自定义参数的个数范围：0~10 键不允许为空字符串，最多支持64个字符。值允许为空字符串。自定义参数与原始命令内容在Base64编码后，综合长度不能超过16KB。设置的自定义参数名集合必须为创建命令时定义的参数集的子集。对于未传入的参数，您可以使用空字符串代替。默认值：空，表示取消设置该参数从而禁用自定义参数。
KeepCommand	Boolean	否	false	执行完该命令后，是否保留下来。取值范围： true：保留。可以通过InvokeCommand再次执行。会占用云助手命令的保有量配额。 false：不保留。执行完成后自动删除，不占用云助手命令的保有量配额。默认值：false
ContentEncoding	String	否	Base64	命令内容（`CommandContent`）的编码方式。取值范围（不区分大小写）： PlainText：不编码，采用明文传输。 Base64：Base64编码。默认值：PlainText，乱填或错填该取值会当作PlainText处理。
Username	String	否	root	在ECS实例中执行命令的用户名称。 Linux系统的ECS实例，默认以root用户执行命令。 Windows系统的ECS实例，默认以System用户执行命令。您也可以指定实例中已存在的其他用户执行命令，以普通用户执行云助手命令更加安全。更多信息，请参见设置普通用户执行云助手命令。
WindowsPasswordName	String	否	axtSecretPassword	在Windows实例中执行命令的用户的密码名称。当您希望以非默认用户（System）在Windows实例中执行命令时，需要同时传入`Username`和该参数。为降低密码泄露的风险，需要将密码明文托管在运维编排服务的参数仓库中，此处仅传入密码的名称。更多信息，请参见加密参数以及设置普通用户执行云助手命令。说明当您使用Linux实例的root用户或Windows实例的System用户执行命令时，不需要传递该参数。

返回数据


名称	类型	示例值	描述
CommandId	String	c-7d2a745b412b4601b2d47f6a768d****	命令ID。
InvokeId	String	t-7d2a745b412b4601b2d47f6a768d****	命令执行ID。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。

示例

请求示例

http(s)://ecs.aliyuncs.com/?Action=RunCommand
&CommandContent='echo hello'
&InstanceId.1=i-bp185dy2o3o6neg****
&Name=Test
&RegionId=cn-hangzhou
&Type=RunShellScript
&Username=root
&<公共请求参数>

正常返回示例

XML格式

<RunCommandResponse>
        <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
        <CommandId>c-7d2a745b412b4601b2d47f6a768d****</CommandId>
        <InvokeId>t-7d2a745b412b4601b2d47f6a768d****</InvokeId>
</RunCommandResponse>

JSON格式

{
    "RequestId": "E69EF3CC-94CD-42E7-8926-F133B86387C0",
    "CommandId": "c-7d2a745b412b4601b2d47f6a768d****",
    "InvokeId": "t-7d2a745b412b4601b2d47f6a768d****"
}

错误码


HttpCode	错误码	错误信息	描述
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定地域下不支持调用API。请检查RegionId参数取值是否正确。
500	InternalError.Dispatch	An error occurred when you dispatched the request.	发送请求时发生错误，请稍后重试。
403	InvalidCmdType.NotFound	The specified command type does not exist.	指定的命令类型不存在。
403	CmdName.ExceedLimit	The length of the command name exceeds the upper limit.	命令名称长度超过上限。
403	CmdDesc.ExceedLimit	The length of the command description exceeds the upper limit.	命令描述长度超过上限。
403	CmdCount.ExceedQuota	The total number of commands in the current region exceeds the quota.	当前地域下的云助手命令数量已超出限。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定的实例不存在。
403	InvalidInstance.NotMatch	The specified instance type does not match the command.	指定的实例ID不支持执行指定的命令ID。请检查实例的状态是否符合云助手命令的执行条件。
404	InvalidCmdId.NotFound	The specified command ID does not exist.	指定的CommandId参数有误，请检查参数值是否正确。您可以通过接口DescribeCommands查询所有可用的CommandId。
403	MissingParam.Frequency	The frequency must be specified when you create a timed task.	创建定时任务时必须指定频率。
403	InvalidParam.Frequency	The specified frequency is invalid.	指定的Frequency参数无效。请检查参数值是否正确。
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	目标实例数量超过上限。
403	Username.ExceedLimit	The length of the username exceeds the upper limit.	用户名长度超过上限。

访问错误中心查看更多错误码。