InvokeCommand--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

InvokeCommand

最近更新时间：2024.06.13 14:26:06首次发布时间：2023.09.04 15:43:19

调用InvokeCommand接口，创建一个批量作业。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	InvokeCommand	要执行的操作，取值：InvokeCommand。
Version	String	是	2020-04-01	接口的版本，取值：2020-04-01。
CommandId	String	是	cmd-ybtvqkikdih96z8h0842	命令ID，您可以通过DescribeCommands接口查询所有可用的CommandId。
InvocationName	String	否	updateAgent	作业名称。不超过64个字符。暂不限制特殊字符。同地域下作业名称可重复。
InvocationDescription	String	否	description	作业描述，默认为空字符串。不超过256个字符。
Timeout	Integer	否	60	创建的命令在ECS实例中执行时最大的超时时间，单位为秒。默认值：60。可选范围为：30~86400。说明当因为某种原因无法运行创建的命令时，会出现超时现象。超时后，会强制终止命令进程。
Parameters	String	否	{"username":"root","password":"123456"}	命令中包含自定义参数时，需通过本参数传入自定义参数的键值对。例如：命令内容为`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。
InstanceIds.N	String	是	InstanceIds.1=i-bp185dy2o3o6neg**&InstanceIds.2=i-bp185dy2o3o7neg**	实例ID列表，最多支持100个ID。您可以调用DescribeInstances接口查询获取实例ID。参数 - N：表示实例的序号。多个Instance ID之间用`&`分隔。说明若指定了多台实例，但其中存在实例不满足执行条件时（例如：实例处于关机等不可用状态），都需要重新指定。
RepeatMode	String	否	Once	设置命令执行的方式。取值支持： Once：默认，表示立即执行命令。 Rate：周期执行命令，需要通过`Frequency`参数传入Rate表达式指定执行周期。 Fixed：定时执行命令，需要通过`LaunchTime`参数指定的执行时间。
Frequency	String	否	5m	执行频率。仅`RepeatMode=Rate` 时本参数必填。请按如下格式传入Rate表达式指定执行周期： <执行间隔数值><执行间隔单位> 执行间隔单位：支持分钟（m）、小时（h）和天（d），适用于在固定时间间隔执行作业的场景。时间间隔数值范围：分钟 5～60，小时 1～24，天 1～7，且间隔需大于作业的超时时间。执行间隔基于固定频率，与作业实际执行需要的时间无关。创建作业后基于`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	周期结束时间，RFC3339 格式。说明仅`RepeatMode`为`Rate`（周期执行作业）时需填写。

返回数据

名称	类型	示例值	描述
InvocationId	String	ivk-2a745b412b4601b2d47f6a768d****	作业ID。

请求示例

GET /?Action=InvokeCommand&Version=2020-04-01&CommandId=cmd-ybtvqki****&Username=root&InvocationName=updateAgent&InstanceIds.1=i-bp185dy2o3o6neg****&InstanceIds.2=i-bp185dy2o3o7neg**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "InvokeCommand",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "InvocationId": "ivk-2a745b412b4601b2d47f6a768d****"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。