调用DescribeInvocations查看命令详细信息。

接口说明

  • 当您执行命令后，不代表命令一定成功运行，并且一定有预期的命令效果。您需要通过接口返回值查看实际执行结果，以实际输出结果为准。
  • 您可以查询最近2周的执行信息，执行信息的保留上限为10万条。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeInvocations

系统规定参数。取值：DescribeInvocations。

RegionId String 是 cn-hangzhou

地域ID。您可以调用ListRegions查看最新的阿里云地域列表。

InstanceId String 是 3a658ca270df4df39f22e289b338****

轻量应用服务器的实例ID。
PageNumber Integer 否 1

当前页码。

起始值：1。

默认值：1。
PageSize Integer 否 10

分页查询时设置的每页行数。

最大值：50。

默认值：10。
InvokeStatus String 否 Finished

命令运行状态。可能值：

  • Running：命令运行中。
  • Finished：命令执行完成
  • Failed：命令运行失败。

返回数据

名称 类型 示例值 描述
RequestId String 30637AD6-D977-4833-A54C-CC89483E****

请求ID。
Invocations Array of Invocation

命令执行记录。
CreationTime String 2022-07-11T06:37:16Z

命令创建时间。
InvocationStatus String Success

命令执行的状态。可能值：

  • Pending：系统正在校验或发送命令。
  • Invalid：指定命令类型或参数有误。
  • Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成。
  • Running：命令正在实例上执行。
  • Success：命令执行完成，且退出码为0。
  • Failed：命令执行完成，且退出码非0。
  • Error：命令执行时发生异常无法继续。
  • Timeout：命令执行超时。
  • Cancelled：命令的执行动作已经取消，命令未曾启动。
  • Stopping：正在停止执行的命令。
  • Terminated：命令执行时被终止。
CommandType String RunShellScript

命令类型。可能值：

  • RunBatScript：适用于Windows实例的Bat命令。
  • RunPowerShellScript：适用于Windows实例的PowerShell命令。
  • RunShellScript：适用于Linux实例Shell命令。
CommandContent String bHM=

命令内容,，以Base64编码后传输。
Parameters Map

命令中包含自定义参数。如果没有参数，默认为{}.
InvokeStatus String Finished

命令状态。可能值：

  • Running：命令运行中。
  • Finished：命令执行完成。
  • Failed：命令执行失败。
  • Stopped：停止命令。
InvokeId String t-hz02p9545t6****

命令执行ID。
CommandName String testname

命令名称。
PageSize Integer 10

分页查询时设置的每页行数。
PageNumber Integer 1

页码。
TotalCount Integer 10

命令总条数。

示例

请求示例

http(s)://swas.cn-hangzhou.aliyuncs.com/?Action=DescribeInvocations
&RegionId=cn-hangzhou
&InstanceId=3a658ca270df4df39f22e289b338****
&PageNumber=1
&PageSize=10
&InvokeStatus=Finished
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInvocationsResponse>
    <RequestId>30637AD6-D977-4833-A54C-CC89483E****</RequestId>
    <Invocations>
        <CreationTime>2022-07-11T06:37:16Z</CreationTime>
        <InvocationStatus>Success</InvocationStatus>
        <CommandType>RunShellScript</CommandType>
        <CommandContent>bHM=</CommandContent>
        <InvokeStatus>Finished</InvokeStatus>
        <InvokeId>t-hz02p9545t6****</InvokeId>
        <CommandName>testname</CommandName>
    </Invocations>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <TotalCount>10</TotalCount>
</DescribeInvocationsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "30637AD6-D977-4833-A54C-CC89483E****",
  "Invocations" : [ {
    "CreationTime" : "2022-07-11T06:37:16Z",
    "InvocationStatus" : "Success",
    "CommandType" : "RunShellScript",
    "CommandContent" : "bHM=",
    "InvokeStatus" : "Finished",
    "InvokeId" : "t-hz02p9545t6****",
    "CommandName" : "testname"
  } ],
  "PageSize" : 10,
  "PageNumber" : 1,
  "TotalCount" : 10
}

错误码

访问错误中心查看更多错误码。