InvokeCommand

Description

When you call this interface, consider the following:

• The network type of the specified instances must be VPC.
• The target ECS instance must be in the  Running (Running) status.
• The target ECS instance must have the cloud assistant client installed in advance.
• To perform a PowerShell command, make sure that the target Windows ECS instance has been configured with the PowerShell module.
• For one-time invocation (Timed=False), the command will be performed only once.
• For periodical invocation (Timed=True), the first invocation task will start at the time specified in the Frequency parameter. Subsequent invocations will follow the frequency specified in the Frequency parameter. The result of last invocation does not affect the next invocation.
• The scheduled time for periodical invocation is in UTC +08:00, and based on the system time of ECS instances. Make sure that the time on your ECS instances are consistent with your expectation.
• You can specify multiple ECS instances in the InstanceIds. When one of these instances does not comply with the invocation conditions, you can try again by specifying other instances.
• Command invocation may fail because of target instance status exception, network exception or cloud assistant client exception. No invocation information is generated for invocation failures.

Request parameters

Response parameters

Examples

https://ecs.aliyuncs.com/?Action=InvokeCommand
&RegionId=cn-hangzhou
&InstanceIds=i-bp185dy2o3o6nxxxxxxx
&CommandId=c-e996287206324975b5fbe1dxxxxxxxxx
&Timed=true
&Frequency=0 0-5 14 * * ?
&<Common Request Parameters>

<InvokeCommandResponse>
    <RequestId>540CFF28-407A-40B5-B6A5-73Bxxxxxxxxx</RequestId>
    <InvokeId>t-1fad2a8876de47068cc734d5xxxxxxxxx</InvokeId>
</InvokeCommandResponse>

{
    "RequestId":"540CFF28-407A-40B5-B6A5-73Bxxxxxxxxx",
    "InvokeId":"t-1fad2a8876de47068cc734d5xxxxxxxxx"
|

<Error>
    <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId>
    <HostId>ecs.aliyuncs.com</HostId>
    <Code>MissingParameter.CommandId</Code>
    <Message>The input parameter “CommandId” that is mandatory for processing this request is not supplied.</Message>
</Error>

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
    "HostId": "ecs.aliyuncs.com"
    "Code": "MissingParameter.CommandId"
    "Message": "The input parameter “CommandId” that is mandatory for processing this request is not supplied."
}

Error codes

Error codes specific to this interface are as follows. For more information, see API Error Center.