全部產品
Search

搜尋本產品

    Simple Application Server：DescribeCommandInvocations - 查詢命令執行列表和狀態

    文件中心

    Simple Application Server：DescribeCommandInvocations - 查詢命令執行列表和狀態

    更新時間：Dec 21, 2025

    查詢命令助手執行命令的列表和狀態。

    調試

    您可以在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

    否

    指定的Simple Application Server的執行個體 ID。

    ace0706b2ac4454d984295a94213****
    CommandId

    string

    否

    命令 ID。您可以通過介面 DescribeCommands 查詢所有可用的 CommandId。

    c-sh02yh0932w****
    InvokeId

    string

    否

    命令執行 ID。

    t-hz02p9545t6****
    CommandName

    string

    否

    命令名稱。如果同時設定了 InstanceId 參數，則該參數不生效。

    testName
    InvocationStatus

    string

    否

    命令執行的總執行狀態，總執行狀態取決於本次調用的全部執行個體的共同執行狀態，可能值：

    • Pending：系統正在校正或發送命令。存在至少一台執行個體的命令執行狀態為 Pending，則總執行狀態為 Pending。

    • Running：命令正在執行個體上運行。存在至少一台執行個體的命令執行狀態為 Running，則總執行狀態為 Running。

    • Success：各個執行個體上的命令執行狀態均為 Stopped 或 Success，且至少一個執行個體的命令執行狀態是 Success，則總執行狀態為 Success。

      • 立即啟動並執行任務：命令執行完成，且退出碼為 0。

    • Failed：各個執行個體上的命令執行狀態均為 Stopped 或 Failed，則總執行狀態為 Failed。執行個體上的命令執行狀態一項或多項為以下狀態時，傳回值均為 Failed 狀態：

      • 命令校正失敗（Invalid）

      • 命令發送失敗（Aborted）

      • 命令執行完成但退出碼非 0（Failed）

      • 命令執行逾時（Timeout）

      • 命令執行異常（Error）

    • Stopping：正在停止任務。存在至少一台執行個體的命令執行狀態為 Stopping，則總執行狀態為 Stopping。

    • Stopped：任務已停止。所有執行個體的命令執行狀態是 Stopped，則總執行狀態為 Stopped。執行個體上的命令執行狀態為以下狀態時，傳回值均為 Stopped 狀態：

      • 任務已取消（Cancelled）

      • 任務已終止（Terminated）

    • PartialFailed：部分執行個體執行成功且部分執行個體執行失敗。各個執行個體的命令執行狀態均為 Success、Failed 或 Stopped，則總執行狀態為 PartialFailed。

    說明

    返回參數中的InvokeStatus與該參數意義相似，但建議您查看該傳回值。

    Success
    CommandType

    string

    否

    命令類型。可能值：

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

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

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

    RunPowerShellScript
    PageNumber

    string

    否

    當前頁碼。起始值：1。預設值：1。

    1
    PageSize

    string

    否

    分頁查詢時設定的每頁行數。

    最大值：50。

    預設值：10。

    10

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    30637AD6-D977-4833-A54C-CC89483E****
    TotalCount

    integer

    總條數。

    10
    PageNumber

    integer

    查詢結果的頁碼。

    1
    PageSize

    integer

    分頁查詢時設定的每頁行數。

    10
    CommandInvocations

    array<object>

    命令執行列表。

    array<object>

    命令執行資訊結構體。

    InvokeId

    string

    命令執行 ID。

    t-hz0373jyzxt****
    CreationTime

    string

    命令建立時間。

    2023-04-27T10:11:58
    CommandId

    string

    命令 ID。

    c-hy0338xh28r****
    InvocationStatus

    string

    命令執行的狀態。可能值：

    • Pending：系統正在校正或發送命令。

    • Invalid：指定命令類型或參數有誤。

    • Aborted：向執行個體發送命令失敗。執行個體必須在運行中，且命令可以 1 分鐘內發送完成。

    • Running：命令正在執行個體上執行。

    • Success：命令執行完成，且退出碼為 0。

    • Failed：命令執行完成，且退出碼非 0。

    • Error：命令執行時發生異常無法繼續。

    • Timeout：命令執行逾時。

    • Cancelled：命令的執行動作已經取消，命令未曾啟動。

    • Stopping：正在停止執行的命令。

    • Terminated：命令執行時被終止。

    Success
    CommandName

    string

    命令名稱。

    testCommandName
    CommandType

    string

    命令類型。

    RunShellScript
    CommandDescription

    string

    命令描述。

    testDescription
    Username

    string

    執行命令的使用者名稱稱。

    root
    WorkingDir

    string

    命令執行的路徑。

    c:\wwwroot
    Timeout

    integer

    逾時時間，單位為秒（s）。

    60
    CommandContent

    string

    命令內容。

    echo 123
    Parameters

    string

    命令中包含自訂參數。如果沒有參數，預設為{}.

    {}
    InvokeInstances

    array<object>

    執行目標執行個體列表。

    object

    執行目標執行個體資訊結構體。

    InstanceId

    string

    Simple Application Server的執行個體 ID。

    2445f4aecdac4b71ba2c7e3a7ccf****
    StartTime

    string

    命令在執行個體中開始執行的時間。

    2023-05-09T03:32:24Z
    FinishTime

    string

    命令進程的結束時間。

    2023-04-03T02:42:29Z
    InvocationStatus

    string

    單台執行個體的命令進度狀態，可能值：

    • Pending：系統正在校正或發送命令。

    • Invalid：指定命令類型或參數有誤。

    • Aborted：向執行個體發送命令失敗。執行個體必須在運行中，且命令可以 1 分鐘內發送完成。

    • Running：命令正在執行個體上運行。

    • Success：

      • 單次執行的命令：命令執行完成，且退出碼為 0。

      • 定時執行的命令：上一次運行成功且退出碼為 0，且指定的時間已結束。

    • Failed：

      • 單次執行的命令：命令執行完成，且退出碼非 0。

      • 定時執行的命令：上一次運行成功且退出碼非 0，且指定的時間將中止。

    • Error：命令執行時發生異常無法繼續。

    • Timeout：命令執行逾時。

    • Cancelled：命令的執行動作已經取消，命令未曾啟動。

    • Stopping：正在停止任務。

    • Terminated：命令運行時被終止。

    Running
    Output

    string

    命令執行後的輸出資訊。

    OutputMsg
    ExitCode

    integer

    命令的退出碼。

    • Linux 執行個體為 Shell 命令的退出碼。

    • Windows 執行個體為 Bat 或者 PowerShell 命令的退出碼。

    0
    ErrorInfo

    string

    命令的下發失敗或執行失敗原因的詳情，可能值：

    • 空：命令執行正常。

    • the specified instance does not exists：指定的執行個體不存在或已釋放。

    • the instance has released when create task：執行命令期間，該執行個體被釋放。

    • the instance is not running when create task：命令執行時，該執行個體不在運行中。

    • the command is not applicable：命令不適用於指定的執行個體。

    • the specified account does not exists：指定的帳號不存在。

    • the specified directory does not exists：指定的目錄不存在。

    • the cron job expression is invalid：指定的周期運算式不合法。

    • the aliyun service is not running on the instance：雲助手用戶端未運行。

    • the aliyun service in the instance does not response：雲助手用戶端無響應。

    • the aliyun service in the instance is upgrading now：雲助手用戶端正在升級中。

    • the aliyun service in the instance need upgrade：雲助手用戶端需要升級。

    • the command delivery has been timeout：發送命令逾時。

    • the command execution has been timeout：命令執行逾時。

    • the command execution got an exception：命令執行發生異常。

    • the command execution has been interrupted：命令執行被中斷。

    • the command execution exit code is not zero：命令執行結束，退出碼非 0。

    the specified instance does not exists
    ErrorCode

    string

    命令的下發失敗或執行失敗原因的代碼，可能值：

    • 空：命令執行正常。

    • InstanceNotExists：指定的執行個體不存在或已釋放。

    • InstanceReleased：執行命令期間，該執行個體被釋放。

    • InstanceNotRunning：命令執行時，該執行個體不在運行中。

    • CommandNotApplicable：命令不適用於指定的執行個體。

    • AccountNotExists：指定的帳號不存在。

    • DirectoryNotExists：指定的目錄不存在。

    • BadCronExpression：指定的周期運算式不合法。

    • ClientNotRunning：雲助手用戶端未運行。

    • ClientNotResponse：雲助手用戶端無響應。

    • ClientIsUpgrading：雲助手用戶端正在升級中。

    • ClientNeedUpgrade：雲助手用戶端需要升級。

    • DeliveryTimeout：發送命令逾時。

    • ExecutionTimeout：命令執行逾時。

    • ExecutionException：命令執行發生異常。

    • ExecutionInterrupted：命令執行被中斷。

    • ExitCodeNonzero：命令執行結束，退出碼非 0。

    InstanceNotExists

    樣本

    正常返回樣本

    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"
        }
      ]
    }
  ]
}

    錯誤碼

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

    變更歷史

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