查詢命令助手執行命令的列表和狀態。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
swas-open:DescribeCommandInvocations | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。您可以調用 ListRegions 查詢可用地域。 | cn-hangzhou |
InstanceId | string | 否 | 指定的輕量應用服務器的實例 ID。 | ace0706b2ac4454d984295a94213**** |
CommandId | string | 否 | 命令 ID。您可以通過接口 DescribeCommands 查詢所有可用的 CommandId。 | c-sh02yh0932w**** |
InvokeId | string | 否 | 命令執行 ID。 | t-hz02p9545t6**** |
CommandName | string | 否 | 命令名稱。如果同時設置了 InstanceId 參數,則該參數不生效。 | testName |
InvocationStatus | string | 否 | 命令執行的總執行狀態,總執行狀態取決于本次調用的全部實例的共同執行狀態,可能值:
說明
返回參數中的 InvokeStatus 與該參數意義相似,但建議您查看該返回值。
| Success |
CommandType | string | 否 | 命令類型。可能值:
| RunPowerShellScript |
PageNumber | string | 否 | 當前頁碼。起始值:1。默認值:1。 | 1 |
PageSize | string | 否 | 分頁查詢時設置的每頁行數。 最大值:50。 默認值:10。 | 10 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
"TotalCount": 10,
"PageNumber": 1,
"PageSize": 10,
"CommandInvocations": [
{
"InvokeId": "t-hz0373jyzxt****",
"CreationTime": "2023-04-27T10:11:58",
"CommandId": "c-hy0338xh28r****",
"InvocationStatus": "Success",
"CommandName": "testCommandName",
"CommandType": "RunShellScript",
"CommandDescription": "testDescription",
"Username": "root",
"WorkingDir": "c:\\wwwroot",
"Timeout": 60,
"CommandContent": "echo 123",
"Parameters": "{}",
"InvokeInstances": [
{
"InstanceId": "2445f4aecdac4b71ba2c7e3a7ccf****",
"StartTime": "2023-05-09T03:32:24Z",
"FinishTime": "2023-04-03T02:42:29Z",
"InvocationStatus": "Running",
"Output": "OutputMsg",
"ExitCode": 0,
"ErrorInfo": "the specified instance does not exists",
"ErrorCode": "InstanceNotExists"
}
]
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史