全部產品
Search

搜尋本產品

    Elastic Desktop Service：RunCommand - 在雲電腦中執行指令碼

    文件中心

    Elastic Desktop Service：RunCommand - 在雲電腦中執行指令碼

    更新時間：Mar 17, 2026

    在一台或多台Windows作業系統的雲電腦中執行一段PowerShell或者Bat類型的指令碼。

    調試

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

    調試

    授權資訊

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地區 ID。

    cn-hangzhou
    Type

    string

    是

    營運指令碼的語言類型。

    枚舉值：

    • RunPowerShellScript :

      運行 PowerShell 指令碼

    • RunBatScript :

      運行 Bat 指令碼

    RunPowerShellScript
    CommandContent

    string

    是

    指令碼的明文內容或者 Base 64 編碼後的內容。
    指令碼內容 Base 64 編碼後不能超過 16 KB。

    說明

    若為 Base 64 編碼後的指令碼內容，則參數 ContentEncoding 必須配置為 Base64。

    ipconfig
    Timeout

    integer

    否

    執行指令碼的逾時時間，單位為秒。預設值：300。
    當因為進程原因、缺失模組、缺失雲助手用戶端等原因無法運行指令碼時，會出現逾時現象。逾時後，會強制終止指令碼進程。

    3600
    ContentEncoding

    string

    否

    指令碼內容的編碼方式。

    說明

    若傳入的值不在枚舉值範圍內，則一律作為傳入PlainText處理。

    枚舉值：

    • Base64 :

      Base 64 編碼

    • PlainText :

      不編碼，採用明文傳輸 [預設值]

    Base64
    DesktopId

    array

    是

    雲電腦 ID 列表。N 的取值範圍：1~50。
    如果指定了多台雲電腦，只要有一台雲電腦可以成功執行指令碼，該 API 就能調用成功。當指定的多台雲電腦均無法執行指令碼時，您需要重新設定該參數。

    string

    否

    雲電腦 ID。

    ecd-7w78ozhjcwa3u****
    EndUserId

    string

    否

    終端使用者的 ID，若此參數不為空白，則會以終端使用者的許可權執行命令。

    說明

    該使用者需要在雲電腦上存在會話記錄（雲電腦開機後有過登入及串連行為，且串連時未被其他使用者搶佔）。Linux 雲電腦不支援該參數。

    alice
    CommandRole

    string

    否

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回對象。

    InvokeId

    string

    指令碼執行 ID。可以調用 DescribeInvocations 並傳入該值來查詢指令碼執行狀態。

    t-hz01qgsqj2n****
    RequestId

    string

    請求 ID。

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****

    樣本

    正常返回樣本

    JSON格式

    {
  "InvokeId": "t-hz01qgsqj2n****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

    錯誤碼

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

    變更歷史

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