全部產品
Search
文件中心

Simple Application Server:RunCommand - 執行命令

更新時間:Dec 21, 2025

在Simple Application Server上執行命令。

介面說明

命令助手是專為Simple Application Server打造的自動化營運工具。您無需登入,即可在控制台上通過命令(Shell、Powershell 和 Bat)對Simple Application Server執行個體進行營運管理操作。

使用命令助手時,需滿足以下條件:

  • Simple Application Server執行個體的狀態必須為運行中。

  • 已安裝雲助手用戶端。Simple Application Server執行個體預設已安裝雲助手用戶端,如果您手動卸載,需重新安裝。具體操作,請參見安裝雲助手用戶端

調試

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

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

swas-open:RunCommand

create

*Command

acs:swas-open:{#regionId}:{#accountId}:{#CommandId}

請求參數

名稱

類型

必填

描述

樣本值

CommandContent

string

命令內容。您需要注意:

  • 指定參數EnableParameter=true可在命令內容中啟用自訂參數功能:

  • 用{{}}包含的方式定義自訂參數,在{{}}內參數名前後的空格以及分行符號會被忽略。

  • 自訂參數個數不能超過 20 個。

  • 自訂參數名允許 a-zA-Z0-9-_的組合,不支援其餘字元,參數名不區分大小寫。

  • 單個自訂參數名不能超過 64 位元組。

ifconfig -s

WorkingDir

string

您可自訂命令的執行路徑。預設路徑如下:

  • Linux 執行個體:執行路徑預設在管理員 root 使用者的/root 目錄下。

  • Windows 執行個體:執行路徑預設在 C:\Windows\system32 目錄下。

/root

RegionId

string

地區 ID。您可以調用 ListRegions 查看最新的阿里雲地區列表。

cn-hangzhou

Timeout

integer

設定命令在伺服器執行個體中的逾時時間,單位為秒。

當執行命令的任務逾時後,命令助手將強制終止任務進程。可設定逾時時間取值範圍為 10~86400 秒(24 小時)。

預設值:60。

60

Type

string

命令的語言類型。取值範圍:

  • RunBatScript:適用於 Windows 執行個體的 Bat 命令。

  • RunPowerShellScript:適用於 Windows 執行個體的 PowerShell 命令。

  • RunShellScript:適用於 Linux 執行個體 Shell 命令。

RunShellScript

EnableParameter

boolean

命令中是否包含自訂參數。

預設值:false。

false

Parameters

object

命令中包含自訂參數時,執行命令時傳入的自訂參數的索引值對。例如,命令內容為echo {{name}},則可以通過Parameters參數傳入索引值對{"name":"Jack"}。自訂參數將自動替換變數值name,得到一條新的命令,實際執行的是echo Jack

自訂參數的個數範圍為 0~20,且您需要注意:

  • 鍵不允許為空白字串,最多支援 64 個字元。

  • 值允許為空白字串。

  • 自訂參數與原始命令內容在 Base 64 編碼後,綜合長度不能超過 16 KB。

  • 設定的自訂參數名集合必須為建立命令時定義的參數集的子集。對於未傳入的參數,您可以使用Null 字元串代替。

預設值為空白,表示取消設定該參數從而禁用自訂參數。

{"name":"Jack", "accessKey":"LTAI****************"}

WorkingUser

string

您可以指定以某個Simple Application Server執行個體中存在的使用者執行命令,建議使用普通使用者執行命令可降低安全風險。 預設值:

  • root:Linux 執行個體中預設以 root 使用者執行命令。

  • system:Windows 執行個體中預設以 system 使用者執行命令。

root

WindowsPasswordName

string

Windows 執行個體中執行命令的使用者的密碼名稱。

當您希望以非預設使用者(System)在 Windows 執行個體中執行命令時,需要同時傳入 WorkingUser 和該參數。為降低密碼泄露的風險,需要將密碼明文託管在營運編排服務的參數倉庫中,此處僅傳入密碼的名稱。

axtSecretPassword

InstanceId

string

輕量應用雲端服務器執行個體 ID。

ace0706b2ac4454d984295a94213****

Name

string

執行命令名稱。

testName

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

InvokeId

string

命令執行 ID。

t-hz02p9545t6****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InvokeId": "t-hz02p9545t6****"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情