调用DescribeInvocations查看命令详细信息_轻量应用服务器(SAS)-阿里云帮助中心

查看命令详细信息。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 ListRegions 查看最新的阿里云地域列表。	cn-hangzhou
InstanceId	string	是	轻量应用服务器的实例 ID。	3a658ca270df4df39f22e289b338****
PageNumber	integer	否	当前页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10
InvokeStatus	string	否	命令运行状态。可能值： Running：命令运行中。 Finished：命令执行完成 Failed：命令运行失败。	Finished

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	30637AD6-D977-4833-A54C-CC89483E****
Invocations	object []	命令执行记录。
CreationTime	string	命令创建时间。	2022-07-11T06:37:16Z
InvocationStatus	string	命令执行的状态。可能值： Pending：系统正在校验或发送命令。 Invalid：指定命令类型或参数有误。 Aborted：向实例发送命令失败。实例必须在运行中，且命令可以 1 分钟内发送完成。 Running：命令正在实例上执行。 Success：命令执行完成，且退出码为 0。 Failed：命令执行完成，且退出码非 0。 Error：命令执行时发生异常无法继续。 Timeout：命令执行超时。 Cancelled：命令的执行动作已经取消，命令未曾启动。 Stopping：正在停止执行的命令。 Terminated：命令执行时被终止。	Success
CommandType	string	命令类型。可能值： RunBatScript：适用于 Windows 实例的 Bat 命令。 RunPowerShellScript：适用于 Windows 实例的 PowerShell 命令。 RunShellScript：适用于 Linux 实例 Shell 命令。	RunShellScript
CommandContent	string	命令内容,，以 Base64 编码后传输。	bHM=
Parameters	object	命令中包含自定义参数。如果没有参数，默认为{}.	{}
InvokeStatus	string	命令状态。可能值： Running：命令运行中。 Finished：命令执行完成。 Failed：命令执行失败。 Stopped：停止命令。	Finished
InvokeId	string	命令执行 ID。	t-hz02p9545t6****
CommandName	string	命令名称。	testname
PageSize	integer	分页查询时设置的每页行数。	10
PageNumber	integer	页码。	1
TotalCount	integer	命令总条数。	10

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史