全部產品
Search

搜尋本產品

    Elastic Desktop Service：DescribeInvocations - 查詢雲助手指令碼的執行列表和狀態

    文件中心

    Elastic Desktop Service：DescribeInvocations - 查詢雲助手指令碼的執行列表和狀態

    更新時間：Mar 17, 2026

    用於查詢雲助手指令碼的執行列表和狀態。

    介面說明

    • 當您執行命令後，不代表命令一定成功執行，並且一定有預期的命令效果。您需要通過介面傳回值來查看實際執行結果，以實際輸出結果為準。

    • 您可以查詢最近 2 周的執行資訊，執行資訊的保留上限為 10 萬條。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地區 ID。可以調用 DescribeRegions 擷取無影雲電腦支援的地區列表。

    cn-hangzhou
    InvokeId

    string

    否

    指令碼進程執行 ID。取自 RunCommand 的返回參數。

    t-hz0jdfwd9f****
    CommandType

    string

    否

    營運指令碼的命令類型。

    枚舉值：

    • RunPowerShellScript :

      運行 PowerShell 指令碼

    • RunBatScript :

      運行 Bat 指令碼

    RunPowerShellScript
    InvokeStatus

    string

    否

    指令碼執行的總執行狀態。總執行狀態取決於建立執行中的一台或多台雲電腦的共同執行狀態。

    枚舉值：

    • Finished :

      所有雲電腦全部完成執行。或者手動停止部分雲電腦的指令碼進程，其餘雲電腦全部執行完成

    • Stopped :

      停止執行指令碼

    • Failed :

      所有雲電腦全部執行失敗

    • Running :

      一旦有進行中的指令碼進程，總的執行狀態就為進行中 [預設值]

    • PartialFailed :

      部分雲電腦有執行失敗的指令碼進程，則總執行狀態為部分失敗

    Finished
    DesktopId

    string

    否

    雲電腦 ID。如果指定了雲電腦，則查詢該雲電腦所有的指令碼執行記錄。

    ecd-7w78ozhjcwa3u****
    IncludeOutput

    boolean

    否

    是否在結果中返回指令碼啟動並執行輸出資訊。

    枚舉值：

    • true :

      返回

    • false :

      不返回 [預設值]

    false
    ContentEncoding

    string

    否

    返回資料的編碼方式。

    枚舉值：

    • Base64 :

      返回 Base 64 編碼後的指令碼內容和輸出資訊 [預設值]

    • PlainText :

      返回原始指令碼內容和輸出資訊

    PlainText
    MaxResults

    integer

    否

    分頁查詢時每頁行數。

    • 最大值：50。

    • 預設值：10。

    10
    NextToken

    string

    否

    查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。

    AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
    EndUserId

    string

    否

    使用者識別碼。

    alice
    DesktopIds

    array

    否

    雲電腦 ID 列表。

    說明

    DesktopId參數即將棄用，請使用當前參數傳遞雲電腦 ID 列表資訊。

    string

    否

    雲電腦 ID。

    ecd-84mztzatmipf2****
    IncludeInvokeDesktops

    boolean

    否

    遠程命令在多台雲電腦上執行的情況下，是否返回所有雲電腦的執行結果。

    枚舉值：

    • true :

      返回

    • 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

    指令碼內容，以 Base 64 編碼後傳輸。

    cnBtIC1xYSB8IGdyZXAgdnNm****
    CommandType

    string

    指令碼類型。

    RunPowerShellScript
    InvocationStatus

    string

    指令碼執行的總執行狀態，總執行狀態取決於本次調用的全部雲電腦的共同執行狀態，可能值：

    • Pending：系統正在校正或發送命令。存在至少一台雲電腦的指令碼執行狀態為 Pending，則總執行狀態為 Pending。

    • Running：命令正在雲電腦上運行。存在至少一台雲電腦的指令碼執行狀態為 Running，則總執行狀態為 Running。

    • Success：各個雲電腦上的指令碼執行狀態均為 Stopped 或 Success，且至少一個雲電腦的指令碼執行狀態是 Success，則總執行狀態為 Success。

    • Failed：各個雲電腦上的指令碼執行狀態均為 Stopped 或 Failed，則總執行狀態為 Failed。雲電腦上的指令碼執行狀態一項或多項為以下狀態時，傳回值均為 Failed 狀態：

      • 命令校正失敗（Invalid）

      • 命令發送失敗（Aborted）

      • 命令執行完成但退出碼非 0（Failed）

      • 命令執行逾時（Timeout）

      • 命令執行異常（Error）

    • Stopping：正在停止任務。存在至少一台執行個體的指令碼執行狀態為 Stopping，則總執行狀態為 Stopping。

    • Stopped：任務已停止。所有執行個體的指令碼執行狀態是 Stopped，則總執行狀態為 Stopped。執行個體上的指令碼執行狀態為以下狀態時，傳回值均為 Stopped 狀態：

      • 任務已取消（Cancelled）

      • 任務已終止（Terminated）

    • PartialFailed：部分執行個體執行成功且部分執行個體執行失敗。各個執行個體的指令碼執行狀態均為 Success、Failed 或 Stopped，則總執行狀態為 PartialFailed。

    Pending
    CreationTime

    string

    任務的建立時間。

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

    string

    終端使用者識別碼。

    User1
    InvokeDesktops

    array<object>

    執行目標雲電腦列表。

    object

    執行目標雲電腦。

    InvocationStatus

    string

    單台雲電腦的指令碼進度狀態。

    Success
    Output

    string

    指令碼進程的輸出資訊。

    • 如果請求參數IncludeOutput設定為 false，則不返回 Output。

    • 如果請求參數ContentEncoding設定為 Base64，則 Output 為 Base 64 編碼後的輸出資訊。

    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

    命令的下發失敗或執行失敗原因的代碼，可能值：

    • 空：命令運行正常。

    • InstanceNotExists：指定的雲電腦不存在或已釋放。

    • InstanceReleased：執行任務期間，該雲電腦被釋放。

    • InstanceNotRunning：建立任務時，該雲電腦不在運行。

    • CommandNotApplicable：命令不適用於指定的雲電腦。

    • ClientNotRunning：雲助手用戶端未運行。

    • ClientNotResponse：雲助手用戶端無響應。

    • ClientIsUpgrading：雲助手用戶端正在升級中。

    • ClientNeedUpgrade：雲助手用戶端需要升級。

    • DeliveryTimeout：發送命令逾時。

    • ExecutionTimeout：命令運行逾時。

    • ExecutionException：命令運行發生異常。

    • ExecutionInterrupted：命令運行任務中斷。

    • ExitCodeNonzero：命令執行結束，退出碼非 0。

    InstanceNotExists
    ErrorInfo

    string

    命令的下發失敗或執行失敗原因的詳情，可能值：

    • 空：命令運行正常。

    • 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：雲助手用戶端未運行。

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

    string

    雲電腦名稱。

    demo1234
    InvokeDesktopCount

    integer

    執行指令碼的雲電腦總數量。

    1
    InvokeDesktopSucceedCount

    integer

    執行指令碼成功的雲電腦總數量。

    1

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。