在輕量應用服務器上執行命令。
接口說明
命令助手是專為輕量應用服務器打造的自動化運維工具。您無需登錄,即可在控制臺上通過命令(Shell、Powershell 和 Bat)對輕量應用服務器實例進行運維管理操作。
使用命令助手時,需滿足以下條件:
- 輕量應用服務器實例的狀態必須為運行中。
- 已安裝云助手客戶端。輕量應用服務器實例默認已安裝云助手客戶端,如果您手動卸載,需重新安裝。具體操作,請參見安裝云助手客戶端。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
swas-open:RunCommand | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CommandContent | string | 是 | 命令內容。您需要注意:
| ifconfig -s |
WorkingDir | string | 否 | 您可自定義命令的執行路徑。默認路徑如下:
| /root |
RegionId | string | 是 | 地域 ID。您可以調用 ListRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
Timeout | integer | 否 | 設置命令在服務器實例中的超時時間,單位為秒。 當執行命令的任務超時后,命令助手將強制終止任務進程。可設定超時時間取值范圍為 10~86400 秒(24 小時)。 默認值:60。 | 60 |
Type | string | 是 | 命令的語言類型。取值范圍:
| RunShellScript |
EnableParameter | boolean | 否 | 命令中是否包含自定義參數。 默認值:false。 | false |
Parameters | object | 否 | 命令中包含自定義參數時,執行命令時傳入的自定義參數的鍵值對。例如,命令內容為 自定義參數的個數范圍為 0~20,且您需要注意:
默認值為空,表示取消設置該參數從而禁用自定義參數。 | {"name":"Jack", "accessKey":"LTAIdyvdIqaRY****"} |
WorkingUser | string | 否 | 您可以指定以某個輕量應用服務器實例中存在的用戶執行命令,建議使用普通用戶執行命令可降低安全風險。 默認值:
| root |
WindowsPasswordName | string | 否 | Windows 實例中執行命令的用戶的密碼名稱。 當您希望以非默認用戶(System)在 Windows 實例中執行命令時,需要同時傳入 WorkingUser 和該參數。為降低密碼泄露的風險,需要將密碼明文托管在運維編排服務的參數倉庫中,此處僅傳入密碼的名稱。 | axtSecretPassword |
InstanceId | string | 是 | 輕量應用云服務器實例 ID。 | ace0706b2ac4454d984295a94213**** |
Name | string | 是 | 執行命令名稱。 | testName |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"InvokeId": "t-hz02p9545t6****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|