為一台或多台ECS執行個體觸發一條雲助手命令。

描述

當您使用該介面時，請注意：

  • 在一個阿里雲地域下，您每天最多能運行500次雲助手命令。
  • 目標執行個體的網路類型必須是Virtual Private Cloud。
  • 目標執行個體的狀態必須為 運行中（Running）。
  • 目標執行個體必須預先安裝 雲助手用戶端。
  • 執行類型為PowerShell的命令時，您需要確保目標ECS Windows執行個體已經配置了PowerShell模組。
  • 對於單次執行（Timed=False），只執行一次命令。
  • 對於周期執行（Timed=True），雲助手將根據參數Frequency指定的時間頻率定時執行。上次的執行結果不對下一次執行產生任何影響。
  • 周期執行的時間設定基準為UTC +08:00，且該時間以執行個體的系統時間為準，您需要確保您的ECS執行個體的時間或者時區與您預期的時間一致。
  • 您可以選擇多台ECS執行個體，若其中某台執行個體不滿足執行條件時，您需要重新選擇。
  • 命令的執行可能會因為目標執行個體的狀態異常、網路異常或雲助手用戶端異常而出現無法執行的情況，無法執行時不會生成執行資訊。

請求參數

名稱 類型 是否必需 描述
Action String 是 系統規定參數。取值：InvokeCommand
RegionId String 是 地域ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。
InstanceId.N Array 是 需要執行命令的執行個體列表，最多能指定20台執行個體ID。N的取值範圍為[1, 20]。
CommandId String 是 命令 ID。您可以通過介面 DescribeCommands 查詢所有可用的CommandId。
Timed Boolean 否 命令是否為周期執行。

預設值：False
Frequency String 否 周期任務的執行循環，兩次周期任務的時間間隔不能低於10秒。當參數 Timed 的值為True時，參數Frequency為必需參數。

該參數取值遵循Cron運算式，參閱 Cron 運算式Cron 運算式。

返回參數

名稱 類型 描述
InvokeId String 命令執行ID

樣本

請求樣本 
https://ecs.aliyuncs.com/?Action=InvokeCommand
&RegionId=cn-hangzhou
&InstanceId.1=i-bp185dy2o3o6nxxxxxxx
&InstanceId.2=i-bsdn5dy2o845sxxxxxxx
&CommandId=c-e996287206324975b5fbe1dxxxxxxxxx
&Timed=true&Frequency=0 0-5 14 * * ?
&<公共請求參數>
正常返回樣本

XML格式

<InvokeCommandResponse>
    <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
    <InvokeId>t-7d2a745b412b4601b2d47f6a768d3a14</InvokeId>
</InvokeCommandResponse>
JSON格式 
{
    "RequestId":"E69EF3CC-94CD-42E7-8926-F133B86387C0",
    "InvokeId":"t-7d2a745b412b4601b2d47f6a768d3a14"
}
異常返回樣本

XML格式

<Error>
    <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</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>
JSON格式 
{
    "RequestId": "E69EF3CC-94CD-42E7-8926-F133B86387C0",
    "HostId": "ecs.aliyuncs.com"
    "Code": "MissingParameter.CommandId"
    "Message": "The input parameter “CommandId” that is mandatory for processing this request is not supplied."
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼，請訪問 API 錯誤中心 。

錯誤碼 錯誤資訊 HTTP狀態碼 說明
InvalidInstanceStatus The specified instance’s status can not execute this operation 400 指定執行個體的狀態必須為運行中；或者指定執行個體的網路狀態異常。
MissingParameter.CommandId The input parameter “CommandId” that is mandatory for processing this request is not supplied. 400 您必須指定必需參數CommandId。
MissingParameter.InstanceIds The input parameter “InstanceIds” that is mandatory for processing this request is not supplied. 400 您必須指定必需參數InstanceId.N。
MissingParameter.RegionId The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 您必須指定必需參數RegionId，或者您暫時不能使用指定RegionId裡的資源。
MissingParameter.Frequency The frequency parameter must exist when create a timed Invocation. 400 當參數Timed的值為True時，您必須指定參數Frequency。
InvalidParam.Frequency The specified frequency is invalid. 403 指定的 Frequency 不合法。
InstanceIds.ExceedLimit The number of instance IDs exceeds the upper limit. 403 最多能指定20台執行個體ID。
Invocation.ExceedQuota The invocation quota in the current region has been reached for today. 403 在一個阿里雲地域下，您每天最多能運行500次雲助手命令。
InvalidCmdId.NotFound The specified commandId does not exist. 404 指定的CommandId不存在。
InvalidInstance.NotFound The specified instances does not exist. 404 指定的InstanceId不存在。
InvalidRegionId.NotFound The RegionId provided does not exist in our items. 404 指定的RegionId不存在。
InternalError.Dispatch An internal error occurred when dispatching your request. 500 內部錯誤，請稍後嘗試。