調用InvokeCommand執行命令助手命令-Simple Application Server-阿里雲

介面說明

對目標Simple Application Server有如下限制，當您選擇多台Simple Application Server後，若其中某台Simple Application Server不滿足執行條件，需要重新調用該介面。
- 伺服器狀態必須為運行中（Running），您可以調用 ListInstances 查詢。
- 已預先安裝雲助手 Agent。
- 執行類型為 PowerShell 的命令時，必須已經配置了 PowerShell 模組。
命令可能會因為目標伺服器的狀態異常，網路異常或雲助手 Agent 異常而出現無法執行的情況，無法執行不會產生執行資訊。
當您建立命令啟用了自訂參數時，需要在執行命令時傳入自訂參數（Parameters）。
調用此介面時您只能選擇一條公用命令或您建立的自訂命令。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

swas-open:InvokeCommand

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。您可以調用 ListRegions 查詢可用地區。	cn-hangzhou
CommandId	string	是	命令 ID。您可以通過介面 DescribeCommands 查詢所有可用的 CommandId。	c-sh02yh0932w****
Parameters	object	否	啟用自訂參數功能時，執行命令時傳入的自訂參數的索引值對。自訂參數的個數範圍為 0~10。Map 的鍵不允許為空白字串，最多支援 64 個字元。 Map 的值允許為空白字串。自訂參數與原始命令內容在 Base 64 編碼後，綜合長度不能超過 18KB。設定的自訂參數名集合必須為建立命令時定義的參數集的子集。對於未傳入的參數，您可以使用Null 字元串代替。您可以取消設定該參數從而禁用自訂參數。	{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
Username	string	否	在Simple Application Server中執行命令的使用者名稱稱。長度不得超過 255 個字元。 Linux 系統的Simple Application Server，預設以 root 使用者執行命令。 Windows 系統的Simple Application Server，預設以 System 使用者執行命令。您可以修改 Linux 系統執行使用者，Windows 系統執行使用者不支援修改。	test
InstanceIds	string	是	Simple Application Server的執行個體 ID。取值可以由多個執行個體 ID 組成一個 JSON 數組，最多支援 50 個 ID，ID 之間用半形逗號（,）隔開。	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	20758A-585D-4A41-A9B2-28DA8F4F****
InvokeId	string	命令執行 ID。	t-bj02prjhw1n****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "InvokeId": "t-bj02prjhw1n****"
}

錯誤碼

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

變更歷史

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