查詢 ECS 執行個體中的雲助手命令執行列表及狀態。

描述

參數 InvokeStatus執行完成Finished) 時僅表示命令進程執行完成,不代表一定有預期的命令效果,您需要通過 DescribeInvocationResults 中的參數 Output 查看實際的具體執行結果。

請求參數

名稱 類型 是否必需 描述
Action String 系統規定參數。取值:DescribeInvocations
RegionId String ECS 執行個體所在的地域 ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。
InvokeId String 命令進程執行 ID。
CommandId String 命令 ID。您可以通過介面 DescribeCommands 查詢所有可用的 CommandId
CommandName String 命令名稱。
Type String 命令類型。取值範圍:
  • RunBatScript:查詢的命令進程為是一個在 Windows 執行個體中啟動並執行 Bat 指令碼或直譯式程式
  • RunPowerShellScript:查詢的命令進程為是一個在 Windows 執行個體中啟動並執行 PowerShell 指令碼或直譯式程式
  • RunShellScript:查詢的命令進程為是一個在 Linux 執行個體中啟動並執行 Shell 指令碼或直譯式程式
Timed Boolean 命令是否為周期執行。預設值:False
InvokeStatus String 指定的命令總的執行狀態。總的執行狀態取決於指定命令管理的所有目標執行個體中的命令進程執行狀態 InstanceInvokeStatus。取值範圍:
  • Running:命令進程進行中
    • 周期執行:未手動停止周期執行命令前,命令進程一直為 進行中Running)。
    • 單次執行:指定命令管理的所有目標執行個體中一旦有 進行中Running)的命令進程,總的執行狀態為 進行中Running)。
  • Finished:命令進程執行完成
    • 周期執行:命令進程不可能為 執行完成Finished)。
    • 單次執行:指定命令管理的所有目標執行個體全部執行完成,總的執行狀態為 執行完成Finished)。

      或者 手動停止Stopped)部分目標執行個體的命令進程,其餘目標執行個體全部執行完成,總的執行狀態為 執行完成Finished)。

  • Failed:命令進程執行失敗,命令進程出現逾時情況或者其他異常
    • 周期執行:命令進程不可能為 執行失敗Failed)。
    • 單次執行:指定命令管理的所有目標執行個體全部執行失敗,總的執行狀態為 執行失敗Failed)。
  • PartialFailed:命令進程執行部分失敗
    • 周期執行:命令進程不可能為 部分失敗PartialFailed)。
    • 單次執行:指定命令管理的所有目標執行個體中個別有 執行失敗Failed)的命令進程,總的執行狀態為 部分失敗PartialFailed)。
  • Stopped:命令進程被手動停止
InstanceId String 執行個體 ID。當您傳入了該參數,將查詢該執行個體所有的命令執行記錄。
PageNumber Integer 當前頁碼,起始值:1

預設值:1

PageSize Integer 分頁查詢時設定的每頁行數,最大值:50

預設值:10

返回參數

名稱 類型 描述
TotalCount Integer 命令總個數
PageNumber Integer 查詢結果的頁碼
PageSize Integer 每頁行數
Invocations Array 命令執行記錄集類型(InvocationSetType
命令執行記錄集類型 InvocationSetType
名稱 類型 描述
Invocation Array 命令執行類型(InvocationType
命令執行類型 InvocationType
名稱 類型 描述
InvokeId String 命令執行 ID
CommandId String 命令 ID
CommandName String 命令名稱
InvokeStatus String 指定的命令總的執行狀態。總的執行狀態取決於指定命令管理的所有目標執行個體中的命令進程執行狀態 InstanceInvokeStatus。取值範圍:
  • Running:命令進程進行中
    • 周期執行:未手動停止周期執行命令前,命令進程一直為 進行中Running)。
    • 單次執行:指定命令管理的所有目標執行個體中一旦有 進行中Running)的命令進程,總的執行狀態為 進行中Running)。
  • Finished:命令進程執行完成
    • 周期執行:命令進程不可能為 執行完成Finished)。
    • 單次執行:指定命令管理的所有目標執行個體全部執行完成,總的執行狀態為 執行完成Finished)。

      或者 手動停止Stopped)部分目標執行個體的命令進程,其餘目標執行個體全部執行完成,總的執行狀態為 執行完成Finished)。

  • Failed:命令進程執行失敗,命令進程出現逾時情況或者其他異常
    • 周期執行:命令進程不可能為 執行失敗Failed)。
    • 單次執行:指定命令管理的所有目標執行個體全部執行失敗,總的執行狀態為 執行失敗Failed)。
  • PartialFailed:命令進程執行部分失敗
    • 周期執行:命令進程不可能為 部分失敗PartialFailed)。
    • 單次執行:指定命令管理的所有目標執行個體中個別有 執行失敗Failed)的命令進程,總的執行狀態為 部分失敗PartialFailed)。
  • Stopped:命令進程被手動停止
CommandType String 命令類型
Timed Boolean 是否為周期執行
Frequency String 周期任務的執行循環。

該參數值結構以 Cron 運算式 為準。

InvokeInstances Array 執行目標執行個體集類型(InvokeInstanceSetType
執行目標執行個體集類型 InvokeInstanceSetType
名稱 類型 描述
InvokeInstance Array 目標執行個體執行狀態類型(InvokeInstanceType
目標執行個體執行狀態類型 InvokeInstanceType
名稱 類型 描述
InstanceId String 執行個體ID
InstanceInvokeStatus String 指定執行個體的命令進程狀態
  • Running:命令進程進行中
    • 周期執行:未手動停止周期執行命令前,命令進程一直為 進行中Running)。
    • 單次執行:指定執行個體的命令進程狀態為 進行中Running)。
  • Finished:命令進程執行完成
    • 周期執行:命令進程不可能為 執行完成Finished)。
    • 單次執行:指定執行個體的命令進程狀態為 執行完成Finished)。
  • Failed:命令進程執行失敗,命令進程出現逾時情況或者其他異常
    • 周期執行:命令進程不可能為 執行失敗Failed)。
    • 單次執行:指定執行個體的命令進程狀態為 執行失敗Failed)。
  • Stopped:命令進程被手動停止

樣本

請求樣本
https://ecs.aliyuncs.com/?Action=DescribeInvocations
&RegionId=cn-hangzhou
&<公共請求參數>
正常返回樣本

XML 格式

<DescribeInvocationsResponse>
    <TotalCount>2</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <Invocations>
        <Invocation>
                <InvokeStatus>Running</InvokeStatus>
                <InvokeId>t-7d2a745b412b4601b2d47f6a768d3b53</InvokeId>
                <CommandName>Test1</CommandName>
                <CommandType>RunShellScript</CommandType>
                <Frequency>0 */20 * * * *</Frequency>
                <InvokeInstances>
                    <InvokeInstance>
                        <InstanceId>i-uf614fhehhzmx</InstanceId>
                        <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
                    </InvokeInstance>
                    <InvokeInstance>
                        <InstanceId>i-uf614fhehhzmy</InstanceId>
                        <InstanceInvokeStatus>Running</InstanceInvokeStatus>
                    </InvokeInstance>
                </InvokeInstances>
                <Timed>True</Timed>
                <CommandId>c-7d2a745b412b4601b2d47f6a768d3a14</CommandId>
        </Invocation>
        <Invocation>
                <InvokeStatus>Finished</InvokeStatus>
                <InvokeId>t-7d2a745b412b4601b2d47f6a768d3b55</InvokeId>
                <CommandName>Test3</CommandName>
                <CommandType>RunShellScript</CommandType>
                <Frequency> </Frequency>
                <InvokeInstances>
                    <InvokeInstance>
                        <InstanceId>i-uf614fhehhzmx</InstanceId>
                        <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
                    </InvokeInstance>
                    <InvokeInstance>
                        <InstanceId>i-uf64isakb713x</InstanceId>
                        <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
                    </InvokeInstance>
                </InvokeInstances>
                <Timed>False</Timed>
                <CommandId>c-7d2a745b412b4601b2d47f6a768d3a16</CommandId>
        </Invocation>
    </Invocations>
    <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
</DescribeInvocationsResponse>
JSON 格式
{
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "Invocations": {
        "Invocation": [
            {
                "InvokeStatus": "Running",
                "InvokeId": "t-7d2a745b412b4601b2d47f6a768d3b53",
                "CommandName": "Test1",
                "CommandType": "RunShellScript",
                "Frequency": "0 */20 * * * *",
                "InvokeInstances": {
                    "InvokeInstance": [
                        {
                            "InstanceId": "i-uf614fhehhzmx",
                            "InstanceInvokeStatus": "Finished"
                        },
                        {
                            "InstanceId": "i-uf64isakb713x",
                            "InstanceInvokeStatus": "Running"
                        }
                    ]
                },
                "Timed": true,
                "CommandId": "c-7d2a745b412b4601b2d47f6a768d3a14"
            },
            {
                "InvokeStatus": "Finished",
                "InvokeId": ">t-7d2a745b412b4601b2d47f6a768d3b55",
                "CommandName": "Test3",
                "CommandType": "RunShellScript",
                "InvokeInstances": {
                    "InvokeInstance": [
                        {
                            "InstanceId": "i-uf614fhehhzmx",
                            "InstanceInvokeStatus": "Finished"
                        },
                        {
                            "InstanceId": "i-uf64isakb713x",
                            "InstanceInvokeStatus": "Finished"
                        }
                    ]
                },
                "Timed": false,
                "CommandId": "c-7d2a745b412b4601b2d47f6a768d3a16"
            } 
        ]
    },
    "RequestId": "E69EF3CC-94CD-42E7-8926-F133B86387C0"
}
異常返回樣本

XML 格式

<Error>
    <RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
    <HostId>ecs.aliyuncs.com</HostId>
    <Code>MissingParameter.RegionId</Code>
    <Message>The input parameter “RegionId” that is mandatory for processing this request is not supplied.</Message>
</Error>
JSON 格式
{
    "RequestId": "E69EF3CC-94CD-42E7-8926-F133B86387C0",
    "HostId": "ecs.aliyuncs.com"
    "Code": "MissingParameter.RegionId"
    "Message": "The input parameter “RegionId” that is mandatory for processing this request is not supplied."
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心

錯誤碼 錯誤資訊 HTTP 狀態碼 說明
MissingParameter.RegionId The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 您必須指定必需參數 RegionId,或者您暫時不能使用指定 RegionId 裡的資源。
InvalidParam.pageNumber The specified parameter is invalid. 403 指定的頁碼不合法。
InvalidParam.PageSize The specified parameter is invalid. 403 指定的頁面大小不合法。
InvalidRegionId.NotFound The RegionId provided does not exist in our items. 404 指定的 RegionId 不存在。
InternalError.Dispatch An internal error occurred when dispath the request 500 內部錯誤,請稍後嘗試。