调用InvokeCommand接口,创建一个批量作业。
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | InvokeCommand | 要执行的操作,取值:InvokeCommand。 |
Version | String | 是 | 2020-04-01 | 接口的版本,取值:2020-04-01。 |
CommandId | String | 是 | cmd-ybtvqkikdih96z8h0842 | 命令ID,您可以通过DescribeCommands接口查询所有可用的CommandId。 |
InvocationName | String | 否 | updateAgent | 作业名称。
|
InvocationDescription | String | 否 | description | 作业描述,默认为空字符串。
|
Timeout | Integer | 否 | 60 | 创建的命令在ECS实例中执行时最大的超时时间,单位为秒。
说明 当因为某种原因无法运行创建的命令时,会出现超时现象。超时后,会强制终止命令进程。 |
Parameters | String | 否 | {"username":"root","password":"123456"} | 命令中包含自定义参数时,需通过本参数传入自定义参数的键值对。 说明 自定义参数规则如下:
|
Username | String | 否 | root | 在ECS实例中执行命令的用户名称。 说明 默认使用命令中的用户名。 |
WorkingDir | String | 否 | /home | 创建的命令在ECS实例中运行的目录。默认值:
|
InstanceIds.N | String | 是 | InstanceIds.1=i-bp185dy2o3o6neg****&InstanceIds.2=i-bp185dy2o3o7neg**** | 实例ID列表,最多支持100个ID。您可以调用DescribeInstances接口查询获取实例ID。
说明 若指定了多台实例,但其中存在实例不满足执行条件时(例如:实例处于关机等不可用状态),都需要重新指定。 |
RepeatMode | String | 否 | Once | 设置命令执行的方式。取值支持:
|
Frequency | String | 否 | 5m | 执行频率。仅
|
LaunchTime | String | 否 | 2022-11-07T11:49:13Z | 执行时间。
|
RecurrenceEndTime | String | 否 | 2022-11-07T11:49:13Z | 周期结束时间,RFC3339 格式。 说明 仅 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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****" } }
您可访问公共错误码,获取更多错误码信息。