すべてのプロダクト
Search

このプロダクト

    Elastic Desktop Service:DescribeInvocations

    ドキュメントセンター

    Elastic Desktop Service:DescribeInvocations

    最終更新日:Mar 17, 2026

    クラウドアシスタントのスクリプトの実行リストとステータスをクエリするために使用されます。

    操作説明

    • コマンドを実行しても、必ずしもコマンドが正常に実行されたり、期待される効果が得られたりするわけではありません。API からの戻り値に基づいて実際の実行結果を確認する必要があり、実際の出力結果が優先されます。

    • 過去 2 週間分の実行情報をクエリでき、最大 100,000 件のレコードが保持されます。

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions 操作を呼び出して、Elastic Desktop Service (EDS) Enterprise が利用可能なリージョンのリストをクエリできます。

    cn-hangzhou
    InvokeId

    string

    任意

    コマンドの実行 ID。 RunCommand 操作を呼び出すことで値を取得できます。

    t-hz0jdfwd9f****
    CommandType

    string

    任意

    コマンドタイプ。

    有効な値：

    • RunPowerShellScript：PowerShell コマンド。

    • RunBatScript：Bat コマンド。

    列挙値:

    • RunPowerShellScript :
    • RunBatScript :

    RunPowerShellScript
    InvokeStatus

    string

    任意

    コマンドの実行ステータス。このパラメーターの値は、参加しているすべてのクラウドコンピューターでのコマンドの実行状態によって決まります。

    有効な値：

    • Finished：すべてのクラウドコンピューターでコマンドの実行が完了します。または、一部のクラウドコンピューターでコマンドの実行が手動で停止され、他のコンピューターでは完了します。

    • Stopped：コマンドの実行が停止します。

    • Failed：すべてのクラウドコンピューターでコマンドの実行が失敗しました。

    • Running：進行中のコマンド実行が 1 つでもある場合、実行ステータスはデフォルトで Running になります。

    • PartialFailed：一部のクラウドコンピューターでコマンドの実行が失敗した場合、実行ステータスは部分的に失敗したと見なされます。

    列挙値:

    • Finished :
    • Stopped :
    • Failed :
    • Running :
    • PartialFailed :

    Finished
    DesktopId

    string

    任意

    クラウドコンピューター ID。クラウドコンピューターを指定すると、そのクラウドコンピューターのすべてのコマンド実行レコードがクエリされます。

    ecd-7w78ozhjcwa3u****
    IncludeOutput

    boolean

    任意

    レスポンスにコマンド出力を含めるかどうかを指定します。

    有効な値：

    • true

    • false (デフォルト)

    列挙値:

    • true :
    • false :

    false
    ContentEncoding

    string

    任意

    コマンド内容と出力のエンコーディング方式。

    有効な値：

    • Base64 (デフォルト)：Base64 でエンコードされたコマンド内容とコマンド出力を返します。

    • PlainText：元のコマンド内容と出力をプレーンテキストで返します。

    列挙値:

    • Base64 :
    • PlainText :

    PlainText
    MaxResults

    integer

    任意

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

    • 有効な値：1～50。

    • デフォルト値：10。

    10
    NextToken

    string

    任意

    クエリトークン。前回の DescribeInvocations 操作の呼び出しから返された NextToken の値を設定します。

    AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
    EndUserId

    string

    任意

    ユーザー ID。

    alice
    DesktopIds

    array

    任意

    クラウドコンピューター ID。

    説明

    DesktopId パラメーターは非推奨になります。代わりに DesktopIds パラメーターを使用してクラウドコンピューター ID を指定することを推奨します。

    string

    任意

    クラウドコンピューター ID。

    ecd-84mztzatmipf2****
    IncludeInvokeDesktops

    boolean

    任意

    複数のクラウドコンピューターで実行された場合に、すべてのクラウドコンピューターでのリモートコマンドの実行結果を返すかどうかを指定します。

    有効な値：

    • true

    • false

    列挙値:

    • true :
    • false :

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    NextToken

    string

    この呼び出しから返されるクエリトークン。

    AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
    RequestId

    string

    リクエストの ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Invocations

    array<object>

    コマンドの実行レコード。

    array<object>

    コマンドの実行レコード。

    InvokeId

    string

    実行の ID。

    t-hz0jdfwd9f****
    CommandContent

    string

    Base64 でエンコードされたコマンド内容。

    cnBtIC1xYSB8IGdyZXAgdnNm****
    CommandType

    string

    コマンドのタイプ。

    RunPowerShellScript
    InvocationStatus

    string

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

    • Pending：コマンドは検証中または送信中です。少なくとも 1 台のクラウドコンピューターで実行ステータスが Pending の場合、全体のステータスは Pending と見なされます。

    • Running：コマンドはクラウドコンピューターで実行中です。少なくとも 1 台のクラウドコンピューターで実行ステータスが Running の場合、全体のステータスは Running と見なされます。

    • Success：少なくとも 1 台のクラウドコンピューターで実行ステータスが Success であり、他のすべてのクラウドコンピューターで Success または Stopped の場合、全体のステータスは Success と見なされます。

    • Failed：すべてのクラウドコンピューターで実行ステータスが Stopped または Failed の場合、全体のステータスは Failed と見なされます。クラウドコンピューターのいずれかの実行ステータスが次のいずれかの値に一致する場合、Failed が返されます。

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

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

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

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

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

    • Stopping：コマンドの実行が停止中です。少なくとも 1 台のクラウドコンピューターで実行ステータスが Stopping の場合、全体のステータスは Stopping と見なされます。

    • Stopped：コマンドの実行が停止します。少なくとも 1 台のクラウドコンピューターで実行ステータスが Stopped の場合、全体のステータスは Stopped と見なされます。クラウドコンピューターのいずれかの実行ステータスが次のいずれかの値に一致する場合、Stopped が返されます。

      • Cancelled：コマンドの実行がキャンセルされました。

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

    • PartialFailed：コマンドの実行は一部のクラウドコンピューターで成功しましたが、他では失敗しました。いずれかのクラウドコンピューターの実行ステータスが Success、Failed、または Stopped の場合、全体のステータスは PartialFailed と見なされます。

    Pending
    CreationTime

    string

    実行タスクが作成された時間。

    2020-12-19T09:15:46Z
    EndUserId

    string

    エンドユーザーの ID。

    User1
    InvokeDesktops

    array<object>

    コマンドが実行されるクラウドコンピューター。

    object

    コマンドが実行されるクラウドコンピューター。

    InvocationStatus

    string

    単一のクラウドコンピューターでのコマンドの実行進捗。

    Success
    Output

    string

    コマンド出力。

    • IncludeOutput パラメーターが false に設定されている場合、出力は返されません。

    • ContentEncoding パラメーターが Base64 に設定されている場合、出力は Base64 でエンコードされた文字列として返されます。

    OutPutTestmsg
    CreationTime

    string

    コマンドの実行が実行された時間。

    2020-12-20T06:15:54Z
    UpdateTime

    string

    実行ステータスが更新された時間。

    2020-12-25T06:15:56Z
    Repeats

    integer

    コマンドがクラウドコンピューターで実行された回数。

    0
    DesktopId

    string

    クラウドコンピューター ID。

    ecd-7w78ozhjcwa3u****
    Dropped

    integer

    Output の値が 24 KB を超えた場合に切り捨てられて破棄されるテキストのサイズ。

    0
    StartTime

    string

    コマンド実行の開始時刻。

    2020-12-20T06:15:55Z
    StopTime

    string

    コマンド実行の停止時刻 (StopInvocation)。

    2020-12-25T09:15:47Z
    FinishTime

    string

    コマンド実行が終了した時間。

    2020-12-20T06:15:56Z
    ExitCode

    integer

    実行の終了コード。

    0
    ErrorCode

    string

    コマンドの送信または実行が失敗した理由を説明するコード。有効な値：

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

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

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

    • InstanceNotRunning：実行中にインスタンスが実行されていません。

    • CommandNotApplicable：指定されたインスタンスでコマンドを実行できません。

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

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

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

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

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

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

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

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

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

    InstanceNotExists
    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 aliyun service is not running on the instance：インスタンス上で Cloud Assistant エージェントが実行されていません。

    • the aliyun service in the instance does not response：インスタンス内の Cloud Assistant エージェントが応答しません。

    • the aliyun service in the instance is upgrading now：インスタンス内の Cloud Assistant エージェントは現在アップグレード中です。

    • the aliyun service in the instance need upgrade：インスタンス内の Cloud Assistant エージェントはアップグレードが必要です。

    • 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 exist.
    DesktopName

    string

    クラウドコンピューター名。

    demo1234
    InvokeDesktopCount

    integer

    コマンドが実行されるクラウドコンピューターの総数。

    1
    InvokeDesktopSucceedCount

    integer

    コマンドの実行が成功したクラウドコンピューターの総数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Invocations": [
    {
      "InvokeId": "t-hz0jdfwd9f****",
      "CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
      "CommandType": "RunPowerShellScript",
      "InvocationStatus": "Pending",
      "CreationTime": "2020-12-19T09:15:46Z",
      "EndUserId": "User1",
      "InvokeDesktops": [
        {
          "InvocationStatus": "Success",
          "Output": "OutPutTestmsg",
          "CreationTime": "2020-12-20T06:15:54Z",
          "UpdateTime": "2020-12-25T06:15:56Z",
          "Repeats": 0,
          "DesktopId": "ecd-7w78ozhjcwa3u****",
          "Dropped": 0,
          "StartTime": "2020-12-20T06:15:55Z",
          "StopTime": "2020-12-25T09:15:47Z",
          "FinishTime": "2020-12-20T06:15:56Z",
          "ExitCode": 0,
          "ErrorCode": "InstanceNotExists",
          "ErrorInfo": "The specified instance does not exist.",
          "DesktopName": "demo1234"
        }
      ],
      "InvokeDesktopCount": 1,
      "InvokeDesktopSucceedCount": 1
    }
  ]
}

    エラーコード

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

    変更履歴

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