すべてのプロダクト
Search

このプロダクト

    Simple Application Server:DescribeCommandInvocations

    ドキュメントセンター

    Simple Application Server:DescribeCommandInvocations

    最終更新日:Dec 21, 2025

    クラウドアシスタントコマンドの実行と実行ステータスを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    swas-open:DescribeCommandInvocations

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。ListRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou
    InstanceId

    string

    任意

    シンプルアプリケーションサーバーの ID。

    ace0706b2ac4454d984295a94213****
    CommandId

    string

    任意

    コマンド ID。DescribeCommands 操作を呼び出して、利用可能なすべてのコマンド ID を照会できます。

    c-sh02yh0932w****
    InvokeId

    string

    任意

    コマンドの実行 ID。

    t-hz02p9545t6****
    CommandName

    string

    任意

    コマンド名。`CommandName` と `InstanceId` の両方が指定されている場合、`CommandName` は有効になりません。

    testName
    InvocationStatus

    string

    任意

    コマンドの全体的な実行ステータス。このパラメーターの値は、関連するすべてのインスタンスでのコマンドの実行ステータスに依存します。有効な値：

    • Pending：コマンドは検証中または送信中です。少なくとも 1 つのインスタンスの実行ステータスが Pending の場合、全体的な実行ステータスは Pending になります。

    • Running：コマンドはインスタンスで実行中です。少なくとも 1 つのインスタンスの実行ステータスが Running の場合、全体的な実行ステータスは Running になります。

    • Success：少なくとも 1 つのインスタンスの実行ステータスが Success であり、他のインスタンスの実行ステータスが Stopped または Success の場合、全体的な実行ステータスは Success になります。

      • すぐに実行するように設定されたコマンド：コマンドの実行が完了し、終了コードが 0 です。

    • Failed：すべてのインスタンスの実行ステータスが Stopped または Failed の場合、全体的な実行ステータスは Failed になります。インスタンスの実行ステータスが次のいずれかの値である場合、全体的な実行ステータスとして Failed が返されます。

      • Invalid：コマンドが無効です。

      • Aborted：コマンドの送信に失敗しました。

      • Failed：コマンドの実行が完了し、終了コードが 0 ではありません。

      • Timeout：コマンドの実行がタイムアウトしました。

      • Error：コマンドの実行中にエラーが発生しました。

    • Stopping：コマンドタスクは停止中です。少なくとも 1 つのインスタンスの実行ステータスが Stopping の場合、全体的な実行ステータスは Stopping になります。

    • Stopped：コマンドタスクは停止しました。すべてのインスタンスの実行ステータスが Stopped の場合、全体的な実行ステータスは Stopped になります。インスタンスの実行ステータスが次のいずれかの値である場合、全体的な実行ステータスとして Stopped が返されます。

      • Cancelled：コマンドタスクはキャンセルされました。

      • Terminated：コマンドタスクは終了しました。

    • PartialFailed：コマンドの実行は一部のインスタンスで成功し、他のインスタンスでは失敗しました。一部のインスタンスの実行ステータスが Success であり、他のインスタンスの実行ステータスが Failed または Stopped の場合、全体的な実行ステータスは PartialFailed になります。

    説明

    レスポンスパラメーター InvokeStatus の値は InvocationStatus の値と似ています。InvokeStatus を無視し、InvocationStatus の値を確認することを推奨します。

    Success
    CommandType

    string

    任意

    コマンドタイプ。有効な値：

    • RunBatScript：バッチコマンド。Windows インスタンスに適用されます。

    • RunPowerShellScript：PowerShell コマンド。Windows インスタンスに適用されます。

    • RunShellScript：シェルコマンド。Linux インスタンスに適用されます。

    RunPowerShellScript
    PageNumber

    string

    任意

    ページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    string

    任意

    1 ページあたりのエントリ数。

    最大値：50。

    デフォルト値：10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    RequestId

    string

    リクエスト ID。

    30637AD6-D977-4833-A54C-CC89483E****
    TotalCount

    integer

    エントリの総数。

    10
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    CommandInvocations

    array<object>

    コマンドの実行。

    array<object>

    InvokeId

    string

    コマンドの実行 ID。

    t-hz0373jyzxt****
    CreationTime

    string

    コマンドが作成された時間。

    2023-04-27T10:11:58
    CommandId

    string

    コマンド ID。

    c-hy0338xh28r****
    InvocationStatus

    string

    コマンドの全体的な実行ステータス。有効な値：

    • Pending：コマンドは検証中または送信中です。

    • Invalid：指定されたコマンドタイプまたはパラメーターが無効です。

    • Aborted：コマンドのインスタンスへの送信に失敗しました。インスタンスにコマンドを送信するには、インスタンスが実行中であり、コマンドが 1 分以内にインスタンスに送信されることを確認してください。

    • Running：コマンドはインスタンスで実行中です。

    • Success：コマンドの実行が完了し、終了コードが 0 です。

    • Failed：コマンドの実行が完了し、終了コードが 0 ではありません。

    • Error：例外のため、コマンドの実行を続行できません。

    • Timeout：コマンドの実行がタイムアウトしました。

    • Cancelled：コマンドの実行はキャンセルされ、コマンドは開始されていません。

    • Stopping：実行中のコマンドは停止中です。

    • Terminated：実行中のコマンドは終了しました。

    Success
    CommandName

    string

    コマンド名。

    testCommandName
    CommandType

    string

    コマンドタイプ。

    RunShellScript
    CommandDescription

    string

    コマンドの説明。

    testDescription
    Username

    string

    コマンドの実行に使用されるユーザー名。

    root
    WorkingDir

    string

    コマンドの作業ディレクトリ。

    c:\wwwroot
    Timeout

    integer

    タイムアウト期間。単位：秒。

    60
    CommandContent

    string

    コマンドの内容。

    echo 123
    Parameters

    string

    コマンド内のカスタムパラメーター。コマンドにカスタムパラメーターが存在しない場合、デフォルト値は {} です。

    {}
    InvokeInstances

    array<object>

    コマンドが実行されるインスタンス。

    object

    InstanceId

    string

    シンプルアプリケーションサーバーの ID。

    2445f4aecdac4b71ba2c7e3a7ccf****
    StartTime

    string

    インスタンスでコマンドが実行される時間範囲の開始時刻。

    2023-05-09T03:32:24Z
    FinishTime

    string

    インスタンスでコマンドが実行される時間範囲の終了時刻。

    2023-04-03T02:42:29Z
    InvocationStatus

    string

    単一インスタンスでのコマンドの実行ステータス。有効な値：

    • Pending：コマンドは検証中または送信中です。

    • Invalid：指定されたコマンドタイプまたはパラメーターが無効です。

    • Aborted：コマンドのインスタンスへの送信に失敗しました。インスタンスにコマンドを送信するには、インスタンスが実行中であり、コマンドが 1 分以内にインスタンスに送信されることを確認してください。

    • Running：コマンドはインスタンスで実行中です。

    • Success：

      • 一度だけ実行するように設定されたコマンド：コマンドの実行が完了し、終了コードが 0 です。

      • スケジュールで実行するように設定されたコマンド：前回のコマンド実行が完了し、終了コードが 0 で、指定されたサイクルが終了しました。

    • Failed：

      • 一度だけ実行するように設定されたコマンド：コマンドの実行が完了し、終了コードが 0 ではありません。

      • スケジュールで実行するように設定されたコマンド：前回のコマンド実行が完了し、終了コードが 0 ではなく、指定されたサイクルが終了しようとしています。

    • Error：例外のため、コマンドの実行を続行できません。

    • Timeout：コマンドの実行がタイムアウトしました。

    • Cancelled：コマンドの実行はキャンセルされ、コマンドは開始されていません。

    • Stopping：コマンドタスクは停止中です。

    • Terminated：実行中のコマンドは終了しました。

    Running
    Output

    string

    コマンドの出力。

    OutputMsg
    ExitCode

    integer

    コマンドの終了コード。

    • Linux インスタンスの場合、終了コードはシェルコマンドの終了コードです。

    • Windows インスタンスの場合、終了コードはバッチまたは PowerShell コマンドの終了コードです。

    0
    ErrorInfo

    string

    コマンドの送信または実行に失敗した場合に返されるエラーメッセージ。有効な値：

    • null：コマンドは期待どおりに実行されます。

    • the specified instance does not exists：指定されたインスタンスが存在しないか、リリースされています。

    • the instance has released when create task：コマンドの実行中にインスタンスがリリースされました。

    • the instance is not running when create task：コマンドの実行中にインスタンスが実行状態ではありません。

    • the command is not applicable：コマンドは指定されたインスタンスに適用できません。

    • the specified account does not exists：指定されたアカウントは存在しません。

    • the specified directory does not exists：指定されたディレクトリは存在しません。

    • the cron job expression is invalid：実行スケジュールに指定された CRON 式が無効です。

    • the aliyun service is not running on the instance：クラウドアシスタントエージェントが実行されていません。

    • the aliyun service in the instance does not response：インスタンス内のクラウドアシスタントエージェントがリクエストに応答しません。

    • the aliyun service in the instance is upgrading now：クラウドアシスタントエージェントは更新中です。

    • the aliyun service in the instance need upgrade：クラウドアシスタントエージェントを更新する必要があります。

    • the command delivery has been timeout：コマンドの送信リクエストがタイムアウトしました。

    • the command execution has been timeout：コマンドの実行がタイムアウトしました。

    • the command execution got an exception：コマンドの実行中に例外が発生しました。

    • the command execution has been interrupted：コマンドの実行が中断されました。

    • the command execution exit code is not zero：コマンドの実行が完了し、終了コードが 0 ではありません。

    the specified instance does not exists
    ErrorCode

    string

    コマンドの送信または実行に失敗した場合に返されるエラーコード。

    • null：コマンドは期待どおりに実行されます。

    • InstanceNotExists：指定されたインスタンスが存在しないか、リリースされています。

    • InstanceReleased：コマンドの実行中にインスタンスがリリースされました。

    • InstanceNotRunning：コマンドの実行中にインスタンスが実行状態ではありません。

    • CommandNotApplicable：コマンドは指定されたインスタンスに適用できません。

    • AccountNotExists：指定されたアカウントは存在しません。

    • DirectoryNotExists：指定されたディレクトリは存在しません。

    • BadCronExpression：実行スケジュールに指定された CRON 式が無効です。

    • ClientNotRunning：クラウドアシスタントエージェントが実行されていません。

    • ClientNotResponse：クラウドアシスタントエージェントがリクエストに応答しません。

    • ClientIsUpgrading：クラウドアシスタントエージェントは更新中です。

    • ClientNeedUpgrade：クラウドアシスタントエージェントを更新する必要があります。

    • DeliveryTimeout：コマンドの送信リクエストがタイムアウトしました。

    • ExecutionTimeout：コマンドの実行がタイムアウトしました。

    • ExecutionException：コマンドの実行中に例外が発生しました。

    • ExecutionInterrupted：コマンドの実行が中断されました。

    • ExitCodeNonzero：コマンドの実行が完了し、終了コードが 0 ではありません。

    InstanceNotExists

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 10,
  "CommandInvocations": [
    {
      "InvokeId": "t-hz0373jyzxt****",
      "CreationTime": "2023-04-27T10:11:58",
      "CommandId": "c-hy0338xh28r****",
      "InvocationStatus": "Success",
      "CommandName": "testCommandName",
      "CommandType": "RunShellScript",
      "CommandDescription": "testDescription",
      "Username": "root",
      "WorkingDir": "c:\\wwwroot",
      "Timeout": 60,
      "CommandContent": "echo 123",
      "Parameters": "{}",
      "InvokeInstances": [
        {
          "InstanceId": "2445f4aecdac4b71ba2c7e3a7ccf****",
          "StartTime": "2023-05-09T03:32:24Z",
          "FinishTime": "2023-04-03T02:42:29Z",
          "InvocationStatus": "Running",
          "Output": "OutputMsg",
          "ExitCode": 0,
          "ErrorInfo": "the specified instance does not exists",
          "ErrorCode": "InstanceNotExists"
        }
      ]
    }
  ]
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。