複数の ECS インスタンスに対して、指定されたコマンドを実行できます。
説明
このインターフェイスを呼び出すときは、次の条件を確認してください。
- 指定するインスタンスのネットワークタイプは VPC でなければなりません。
- ターゲット ECS インスタンスは、実行中 (
Running
) のステータスでなければなりません。 - ターゲット ECS インスタンスには、クラウドアシスタントクライアントがあらかじめインストールされている必要があります。
- PowerShell コマンドを実行するには、対象の Windows ECS インスタンスが PowerShell モジュールで設定されていることを確認します。
- 1 回の呼び出し (
Timed=False
) の場合、コマンドは 1 回だけ実行されます。 - 定期的な呼び出し (
Timed=True
) の場合、最初の呼び出しタスクはFrequency
パラメーターで指定された時刻に開始されます。これ以降の呼び出しは、Frequency
パラメーターで指定された頻度に従います。最後の呼び出しの結果は、次の呼び出しに影響しません。 - 定期的な呼び出しのスケジュール時間は、UTC +08:00 で、ECS インスタンスのシステム時間に基づいています。ECS インスタンスの時間が期待どおりであることを確認してください。
- InstanceIds に複数の ECS インスタンスを指定できます。これらのインスタンスの 1 つが呼び出し条件を見対していない場合は、他のインスタンスを指定することで再試行できます。
- ターゲットインスタンスのステータス例外、ネットワーク例外、クラウドアシスタントクライアント例外などにより、コマンドの呼び出しが失敗することがあります。呼び出しが失敗した場合、呼び出し情報は生成されません。
リクエストパラメーター
名前 | 型 | 必須かどうか | 説明 |
---|---|---|---|
Action | String | はい | このインタフェースの名前。値:InvokeCommand |
RegionId | String | はい | リージョン ID。詳細については、DescribeRegionsを呼び出して、最新のリージョンリストを取得してください。 |
InstanceIds | Array | はい | コマンド呼び出しのインスタンスのリスト。パラメーター値は、[InstanceId1 , instanceId2 , …] の形式で書式設定された JSON 配列です。カンマ (,) で区切られたインスタンス ID を最大 100 個まで指定できます。 |
CommandId | String | はい | コマンド ID。DescribeCommands APIを呼び出して、使用可能なすべての CommandId を確認できます。 |
Timed | Boolean | いいえ | コマンドが定期的に実行されるかどうか。オプションの値:
|
Frequency | String | いいえ | 定期的なタスクの起動期間。Timed パラメーターの値が True の場合、Frequency パラメーターは必須です。パラメーター値は、Cron 式をモニタリングします。詳細については、「Cron 式 」をご参照ください。 |
レスポンスパラメーター
名前 | 型 | 説明 |
---|---|---|
InvokeId | String | コマンド呼び出し ID。 |
例
リクエスト例
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>
レスポンス例 (成功)
XML 形式
JSON 形式
540CFF28-407A-40B5-B6A5-73Bxxxxxxxxx t-1fad2a8876de47068cc734d5xxxxxxxxx
{“RequestId”:”540CFF28-407A-40B5-B6A5-73Bxxxxxxxxx”,“InvokeId”:”t-1fad2a8876de47068cc734d5xxxxxxxxx”|
レスポンス例 (エラー)
XML 形式
JSON 形式
540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx ecs.aliyuncs.com MissingParameter.CommandId
The input parameter “CommandId” that is mandatory for processing this request is not supplied.
{“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.”}
エラーコード
このインターフェイスに固有のエラーコードは次のとおりです。詳細については、「API エラーセンター」をご参照ください。
エラーコード | エラーメッセージ | HTTP ステータスコード | 意味 |
---|---|---|---|
InvalidInstance.NoClient | The specified instances have no cloud assistant client installed. | 400 | ターゲット ECS インスタンスには、クラウドアシスタントクライアントが事前にインストールされている必要があります。詳細については、「クラウドアシスタントクライアント 」をご参照ください。 |
InvalidInstance.NotVpc | The specified instances must be VPC instances. | 400 | 指定された InstanceIds のネットワークタイプは VPC でなければなりません。 |
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 | 必須パラメーター InstanceIds を指定する必要があります。 |
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 パラメーターは必須です。 |
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 | 内部エラー。後でもう一度お試しください。 |