すべてのプロダクト
Search

このプロダクト

    Simple Application Server:DescribeCommandInvocations

    ドキュメントセンター

    Simple Application Server:DescribeCommandInvocations

    最終更新日:Sep 08, 2026

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

    今すぐお試しください

    この 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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 ListRegions を呼び出して利用可能なリージョンを照会できます。

    cn-hangzhou
    InstanceId

    string

    任意

    簡易アプリケーションサーバーのインスタンス ID。

    ace0706b2ac4454d984295a94213****
    CommandId

    string

    任意

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

    c-sh02yh0932w****
    InvokeId

    string

    任意

    コマンド実行 ID。

    t-hz02p9545t6****
    CommandName

    string

    任意

    コマンド名。InstanceId パラメーターも指定されている場合、このパラメーターは効果を発揮しません。

    testName
    InvocationStatus

    string

    任意

    コマンドの全体的な実行ステータス。全体的な実行ステータスは、この呼び出しにおけるすべてのインスタンスの共通の実行ステータスに依存します。有効な値:

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

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

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

      • 単発タスク: コマンドの実行が完了し、終了コードが 0 です。

    • Failed: 各インスタンスでのコマンド実行ステータスが Stopped または Failed です。この場合、全体的な実行ステータスは Failed になります。インスタンスでのコマンド実行ステータスが次のいずれかの値の場合、全体的な実行ステータスは Failed になります。

      • コマンドの検証に失敗した (Invalid)。

      • コマンドの送信に失敗した (Aborted)。

      • コマンドの実行は完了したが、終了コードが 0 ではない (Failed)。

      • コマンドの実行が時間切れになりました (Timeout)。

      • コマンドの実行中に例外が発生した (Error)。

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

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

      • タスクがキャンセルされた (Cancelled)。

      • タスクが終了された (Terminated)。

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

    説明

    InvokeStatus レスポンスパラメーターも同様の意味を持ちますが、このパラメーターの値を確認することを推奨します。

    Success
    CommandType

    string

    任意

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

    • RunBatScript: Windows インスタンス用の Bat コマンド。

    • RunPowerShellScript: Windows インスタンス用の PowerShell コマンド。

    • RunShellScript: Linux インスタンス用の Shell コマンド。

    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

    コマンドが作成された時間。フォーマットは YYYY-MM-DDThh:mm:ss です。

    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

    インスタンスでコマンドが実行中になった時間。時間は協定世界時 (UTC) (Z) で表示され、フォーマットは YYYY-MM-DDThh:mm:ssZ です。

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

    string

    コマンドプロセスが終了した時間。時間は協定世界時 (UTC) (Z) で表示され、フォーマットは YYYY-MM-DDThh:mm:ssZ です。

    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 インスタンスの場合、これは Shell コマンドの終了コードです。

    • Windows インスタンスの場合、これは Bat コマンドまたは PowerShell コマンドの終了コードです。

    0
    ErrorInfo

    string

    コマンドの配信失敗または実行失敗の詳細。有効な値:

    • Empty: コマンドは正常に実行されました。

    • 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

    コマンドの配信失敗または実行失敗のエラーコード。有効な値:

    • Empty: コマンドは正常に実行されました。

    • 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"
        }
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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