InvokeCommand

Description

• You can call the InvokeCommand operation in a region up to 5000 times a day. To adjust the maximum number of daily calls, submit a ticket.
• The target instance type must be VPC.
• The target instance must be in the Running state.
• The target instance must be pre-installed with the cloud assistant client.
• Before you run PowerShell commands, make sure that the target Windows-based instance has the PowerShell feature configured.
• One-time invocations will run the commands only once.
• Periodic invocations will run the commands at the frequency specified by the Frequency parameter. The result of previous invocation does not affect the next invocation.
• Periodic invocation can only be scheduled in UTC+8. If the system time of your ECS instances are not UTC+8, make sure that you have made adjustments to ensure that your commands are executed at the correct time. For more information, see Time setting: Synchronize NTP servers and change time zone for Linux instances or Time setting: Synchronize NTP servers for Windows instances.
• You can specify multiple ECS instances in this command. When one of these instances does not comply with the invocation conditions, you need to specify another instance.
• Command invocations may fail because of target instance status exceptions, network exceptions, or cloud assistant client exceptions. If an invocation fails, no invocation information is generated.
• If you added EnableParameter=true while creating a script, you should specify value for the variables in the InvokeCommand method.

Debugging

You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Response parameters

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=InvokeCommand
&CommandId=c-e996287206324975b5fbe1dxxxxxxxxx 
&InstanceId.1=i-bp185dy2o3o6nxxxxxxx
&RegionId=cn-hangzhou
&Timed=true
&Frequency=0 */20 * * * * 
&<Common request parameters>

Successful response examples

XML format

<InvokeCommandResponse>
  <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
  <InvokeId>t-7d2a745b412b4601b2d47f6a768d3a14</InvokeId> 
</InvokeCommandResponse>

JSON format

{
	"RequestId":"E69EF3CC-94CD-42E7-8926-F133B86387C0",
	"InvokeId":"t-7d2a745b412b4601b2d47f6a768d3a14"
}

Error codes

View error codes