文档

DescribeInvocations - 查看命令详细信息

更新时间:

查看命令详细信息。

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:DescribeInvocationsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
InstanceIdstring

轻量应用服务器的实例 ID。

3a658ca270df4df39f22e289b338****
PageNumberinteger

当前页码。

起始值:1。

默认值:1。

1
PageSizeinteger

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

最大值:50。

默认值:10。

10
InvokeStatusstring

命令运行状态。可能值:

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

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

30637AD6-D977-4833-A54C-CC89483E****
Invocationsobject []

命令执行记录。

CreationTimestring

命令创建时间。

2022-07-11T06:37:16Z
InvocationStatusstring

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

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

命令类型。可能值:

  • RunBatScript:适用于 Windows 实例的 Bat 命令。
  • RunPowerShellScript:适用于 Windows 实例的 PowerShell 命令。
  • RunShellScript:适用于 Linux 实例 Shell 命令。
RunShellScript
CommandContentstring

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

bHM=
Parametersobject

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

{}
InvokeStatusstring

命令状态。可能值:

  • Running:命令运行中。
  • Finished:命令执行完成。
  • Failed:命令执行失败。
  • Stopped:停止命令。
Finished
InvokeIdstring

命令执行 ID。

t-hz02p9545t6****
CommandNamestring

命令名称。

testname
PageSizeinteger

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

10
PageNumberinteger

页码。

1
TotalCountinteger

命令总条数。

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
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)