调用InvokeCommand接口，使用已有自定义命令或公共命令创建任务。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：InvokeCommand

要执行的操作，取值：InvokeCommand。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

Tags.N.Value string[] 可选示例值：Tags.1.Value=v1&Tags.2.Value=v2

用户标签的标签值。

参数 - N：表示标签值的序号，取值范围：1～20。

多个标签值之间用&分隔。

命名规则如下：

只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。

允许为空，长度限制在0～256个字符之间。

说明

如果传入该参数，则必须先传入Tags.N.Key。

Tags.N.Key string[] 可选示例值：Tags.1.Key=k1&Tags.2.Key=k2

用户标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～20。

多个标签键之间用&分隔。

命名规则如下：

不能以volc:或sys:的任意大小写组合开头。

只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。

长度限制在1～128个字符之间。

说明

同一资源的标签键不允许重复。

ProjectName string 可选示例值：default

资源所属项目，一个资源只能归属于一个项目。

WindowsPassword string 可选示例值：--

自定义windows用户的密码

CommandId string 必选示例值：cmd-ydckta****

命令ID，您可以通过DescribeCommands接口查询所有可用的CommandId。

InvocationName string 必选示例值：updateAgent

作业名称。

不超过64个字符。

暂不限制特殊字符。

同地域下作业名称可重复。

InvocationDescription string 可选示例值：description

作业描述，默认为空字符串，不超过256个字符。

Timeout integer 可选示例值：60

创建的命令在ECS实例中执行时最大的超时时间，单位为秒。

默认值：60。

可选范围为：30~86400。

说明

当因为某种原因无法运行创建的命令时，会出现超时现象。超时后，会强制终止命令进程。

Frequency string 可选示例值：5m

执行频率。仅RepeatMode=Rate 时本参数必填。请按如下格式传入Rate表达式指定执行周期：

<执行间隔数值><执行间隔单位>

执行间隔单位：支持分钟（m）、小时（h）和天（d），适用于在固定时间间隔执行作业的场景。

时间间隔数值范围：分钟 5～60，小时 1～24，天 1～7，且间隔需大于作业的超时时间。

执行间隔基于固定频率，与作业实际执行需要的时间无关。

创建作业后基于LaunchTime执行一次，根据间隔设置确定下一次执行时间。

Parameters string 可选示例值：{"username":"root"}

命令中包含自定义参数时，需通过本参数传入自定义参数的键值对。

例如：命令内容为echo {{name}}，则可以通过Parameter参数传入键值对{"name":"Jack"}。自定义参数将自动替换变量值name，得到一条新的命令，实际执行的是echo Jack。

说明

自定义参数个数范围为0~60。

Key不允许为空字符串，最多支持64个字符。

Value允许为空字符串。

自定义参数与原始命令内容在Base64编码后，综合长度不能超过16KB。

设置的自定义参数名集合必须为创建命令时定义的参数集的子集。对于未传入的参数，使用默认值代替。

Username string 可选示例值：root

在ECS实例中执行命令的用户名称。

说明

默认使用命令中的用户名。

WorkingDir string 可选示例值：/home

创建的命令在ECS实例中运行的目录。默认值：

说明

Linux实例：默认路径/home。

RepeatMode string 可选示例值：Rate

设置命令执行的方式。取值支持：

Once：默认，表示立即执行命令。

Rate：周期执行命令，需要通过Frequency参数传入Rate表达式指定执行周期。

Fixed：定时执行命令，需要通过LaunchTime参数指定的执行时间。

LaunchTime string 可选示例值：2022-11-07T11:49:13Z

执行时间。

RepeatMode=Rate时，需按如下格式传入作业首次执行时间：

时间格式：RFC3339，例如：2022-11-07T11:49:13Z。

RepeatMode=Fixed时，需按如下格式传入作业开始执行时间：

时间格式：RFC3339，例如：2022-11-07T11:49:13Z。

RecurrenceEndTime string 可选示例值：2022-11-07T11:49:13Z

周期结束时间，仅适用于周期任务（Rate）。

RFC3339 格式。

说明

仅RepeatMode为Rate（周期执行作业）时需填写。

InstanceIds.N string[] 必选示例值：InstanceIds.1=i-ervasv*****&InstanceIds.2=i-uihrdgh*****

实例ID列表，最多支持200个ID。您可以调用DescribeInstances接口查询获取实例ID。

参数 - N：表示实例的序号。

多个Instance ID之间用&分隔。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InvocationId string 示例值：ivk-2a745b****

任务执行 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.CommandId	The required parameter CommandId is not supplied.	命令 ID 不能为空。
400	InvalidProjects.ListFailed	Fail to list projects.	获取项目失败。
400	LimitExceeded.Tags	You've reached the limit on the number of Tags that you can create.	已达到可创建的标签数量上限。
400	MissingParameter.RecurrenceEndTime	The required RecurrenceEndTime is not supplied.	周期结束时间不能为空。
400	MissingParameter.Frequency	The required Frequency is not supplied.	周期执行规则表达式不能为空。
400	LimitExceeded.MaximumInstanceIds	The specified InstanceIds exceeds the limit.	实例数量超出限制。
400	InvalidRecurrenceEndTime.Malformed	The specified RecurrenceEndTime is malformed.	周期结束时间非法。
400	LimitExceeded.MaximumInvocations	The running invocations exceed the limit.	执行中的作业数量超出限制。
400	MissingParameter.InstanceIds	The required parameter InstanceIds is not supplied.	实例 ID 不能为空。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的标签键不合法。
400	InvalidFrequency.Malformed	The specified Frequency is malformed.	周期执行规则表达式非法。
400	InvalidInvocationName.Malformed	The specified InvocationName is malformed.	指定的作业名称不合法。
400	MissingParameter.AccountId	The required parameter AccountId is not supplied.	用户ID不能为空。
400	LimitExceeded.MaximumInvocationName	The specified InvocationName exceeds the limit.	指定的作业名称长度超出限制。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的标签值不合法。
400	LimitExceeded.MaximumInvocationDescription	The specified InvocationDescription exceeds the limit.	指定的作业描述长度超出限制。
400	InvalidRepeatMode.Malformed	The specified RepeatMode is malformed.	指定的命令执行方式不合法。
400	InvalidParameters.Malformed	The specified Parameters are malformed.	指定的自定义参数不合法。
400	LimitExceeded.MaximumParameters	The specified Parameters exceeds the limit.	指定的自定义参数个数超出限制。
400	MissingParameter.ParameterName	The required Parameters Name is not supplied.	参数名不能为空。
400	LimitExceeded.MaximumParameterName	The specified Parameter Name exceeds the limit.	指定的自定义参数名长度超出限制。
400	InvalidParameterDefinitionType.Malformed	The specified ParameterDefinition Type is malformed.	自定义参数类型不合法。
400	InvalidParameterDefinitions.Malformed	The specified ParameterDefinitions is malformed.	指定的参数定义不合法。
400	MissingParameter.LaunchTime	The required LaunchTime is not supplied.	执行时间不能为空。
400	InvalidLaunchTime.Malformed	The specified LaunchTime is malformed.	指定的执行时间不合法。
400	InvalidCloudAssistantStatus.Malformed	The cloud assistant status of the instance cannot be operated.	当前实例Agent的状态不支持该操作。
400	LimitExceeded.MaximumTimeout	The specified timeout exceeds the limit.	指定的超时时间(s)超出限制。
400	InvalidInstanceId.Unregister	The specified instance is unregister.	指定的实例未注册 Agent。
404	MissingParameter.Tags	The required parameter Tags are empty.	标签参数不能为空。
404	InvalidCommand.NotFound	The specified Command does not exist.	指定的命令不存在。
404	InvalidProject.NotFound	The specified Project does not exist.	指定的项目不存在。
409	InvalidTagKey.Conflict	The specified TagKey already exists.	指定的标签键已存在。
409	InvalidInstanceIds.Conflict	The specified InstanceId already exists.	指定实例 ID 重复。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

云服务器