AI 助理
文档备案控制台
官方文档
首页 无影云电脑企业版 开发参考 API参考（云电脑管控） API目录 云助手 DescribeInvocations - 查询云助手脚本的执行列表和状态

DescribeInvocations - 查询云助手脚本的执行列表和状态

更新时间：
复制 MD 格式
产品详情
我的收藏

用于查询云助手脚本的执行列表和状态。

接口说明

  • 当您执行命令后，不代表命令一定成功执行，并且一定有预期的命令效果。您需要通过接口返回值来查看实际执行结果，以实际输出结果为准。

  • 您可以查询最近 2 周的执行信息，执行信息的保留上限为 10 万条。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeInvocations

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
InvokeId

string

否

脚本进程执行 ID。取自 RunCommand 的返回参数。

t-hz0jdfwd9f****
CommandType

string

否

运维脚本的命令类型。

枚举值：

  • RunPowerShellScript :

    运行 PowerShell 脚本

  • RunBatScript :

    运行 Bat 脚本

RunPowerShellScript
InvokeStatus

string

否

脚本执行的总执行状态。总执行状态取决于创建执行中的一台或多台云电脑的共同执行状态。

枚举值：

  • Finished :

    所有云电脑全部完成执行。或者手动停止部分云电脑的脚本进程，其余云电脑全部执行完成

  • Stopped :

    停止执行脚本

  • Failed :

    所有云电脑全部执行失败

  • Running :

    一旦有进行中的脚本进程，总的执行状态就为进行中 [默认值]

  • PartialFailed :

    部分云电脑有执行失败的脚本进程，则总执行状态为部分失败

Finished
DesktopId

string

否

云电脑 ID。如果指定了云电脑，则查询该云电脑所有的脚本执行记录。

ecd-7w78ozhjcwa3u****
IncludeOutput

boolean

否

是否在结果中返回脚本运行的输出信息。

枚举值：

  • true :

    返回

  • false :

    不返回 [默认值]

false
ContentEncoding

string

否

返回数据的编码方式。

枚举值：

  • Base64 :

    返回 Base64 编码后的脚本内容和输出信息 [默认值]

  • PlainText :

    返回原始脚本内容和输出信息

PlainText
MaxResults

integer

否

分页查询时每页行数。

  • 最大值：50。

  • 默认值：10。

10
NextToken

string

否

查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
EndUserId

string

否

用户 ID。

alice
DesktopIds

array

否

云电脑 ID 列表。

说明

DesktopId参数即将弃用，请使用当前参数传递云电脑 ID 列表信息。

string

否

云电脑 ID。

ecd-84mztzatmipf2****
IncludeInvokeDesktops

boolean

否

远程命令在多台云电脑上执行的情况下，是否返回所有云电脑的执行结果。

枚举值：

  • true :

    返回

  • false :

    不返回

返回参数

名称

类型

描述

示例值

object

返回对象。

NextToken

string

本次调用返回的查询凭证值。

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId

string

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Invocations

array<object>

脚本执行记录数组。

array<object>

脚本执行记录对象。

InvokeId

string

执行 ID。

t-hz0jdfwd9f****
CommandContent

string

脚本内容，以 Base64 编码后传输。

cnBtIC1xYSB8IGdyZXAgdnNm****
CommandType

string

脚本类型。

RunPowerShellScript
InvocationStatus

string

脚本执行的总执行状态，总执行状态取决于本次调用的全部云电脑的共同执行状态，可能值：

  • Pending：系统正在校验或发送命令。存在至少一台云电脑的脚本执行状态为 Pending，则总执行状态为 Pending。

  • Running：命令正在云电脑上运行。存在至少一台云电脑的脚本执行状态为 Running，则总执行状态为 Running。

  • Success：各个云电脑上的脚本执行状态均为 Stopped 或 Success，且至少一个云电脑的脚本执行状态是 Success，则总执行状态为 Success。

  • 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。

Pending
CreationTime

string

任务的创建时间。

2020-12-19T09:15:46Z
EndUserId

string

终端用户 ID。

User1
InvokeDesktops

array<object>

执行目标云电脑列表。

object

执行目标云电脑。

InvocationStatus

string

单台云电脑的脚本进度状态。

Success
Output

string

脚本进程的输出信息。

  • 如果请求参数IncludeOutput设置为 false，则不返回 Output。

  • 如果请求参数ContentEncoding设置为 Base64，则 Output 为 Base64 编码后的输出信息。

OutPutTestmsg
CreationTime

string

脚本进程的创建时间。

2020-12-20T06:15:54Z
UpdateTime

string

任务状态的更新时间。

2020-12-25T06:15:56Z
Repeats

integer

命令在该云电脑上执行的次数。

0
DesktopId

string

云电脑 ID。

ecd-7w78ozhjcwa3u****
Dropped

integer

Output 字段中文字长度超出 24 KB 后，截断丢弃的文字长度。

0
StartTime

string

脚本进程在云电脑中开始执行的时间。

2020-12-20T06:15:55Z
StopTime

string

如果调用了 StopInvocation，则表示停止执行的时间。

2020-12-25T09:15:47Z
FinishTime

string

脚本进程的结束时间。

2020-12-20T06:15:56Z
ExitCode

integer

脚本进程的退出代码。

0
ErrorCode

string

命令的下发失败或执行失败原因的代码，可能值：

  • 空：命令运行正常。

  • InstanceNotExists：指定的云电脑不存在或已释放。

  • InstanceReleased：执行任务期间，该云电脑被释放。

  • InstanceNotRunning：创建任务时，该云电脑不在运行。

  • CommandNotApplicable：命令不适用于指定的云电脑。

  • ClientNotRunning：云助手客户端未运行。

  • ClientNotResponse：云助手客户端无响应。

  • ClientIsUpgrading：云助手客户端正在升级中。

  • ClientNeedUpgrade：云助手客户端需要升级。

  • DeliveryTimeout：发送命令超时。

  • ExecutionTimeout：命令运行超时。

  • ExecutionException：命令运行发生异常。

  • ExecutionInterrupted：命令运行任务中断。

  • ExitCodeNonzero：命令执行结束，退出码非 0。

InstanceNotExists
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 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 exist.
DesktopName

string

云电脑名称。

demo1234
JvsAgentId

string

jvs agent id。

jvs-7xjos2l****
InvokeDesktopCount

integer

执行脚本的云电脑总数量。

1
InvokeDesktopSucceedCount

integer

执行脚本成功的云电脑总数量。

1
DesktopScenario

string

云电脑场景。可能值：

  • Classic：经典云电脑场景。

  • JvsClaw: jvs claw 云电脑场景。

Classic

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Invocations": [
    {
      "InvokeId": "t-hz0jdfwd9f****",
      "CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
      "CommandType": "RunPowerShellScript",
      "InvocationStatus": "Pending",
      "CreationTime": "2020-12-19T09:15:46Z",
      "EndUserId": "User1",
      "InvokeDesktops": [
        {
          "InvocationStatus": "Success",
          "Output": "OutPutTestmsg",
          "CreationTime": "2020-12-20T06:15:54Z",
          "UpdateTime": "2020-12-25T06:15:56Z",
          "Repeats": 0,
          "DesktopId": "ecd-7w78ozhjcwa3u****",
          "Dropped": 0,
          "StartTime": "2020-12-20T06:15:55Z",
          "StopTime": "2020-12-25T09:15:47Z",
          "FinishTime": "2020-12-20T06:15:56Z",
          "ExitCode": 0,
          "ErrorCode": "InstanceNotExists",
          "ErrorInfo": "The specified instance does not exist.",
          "DesktopName": "demo1234",
          "JvsAgentId": "jvs-7xjos2l****"
        }
      ],
      "InvokeDesktopCount": 1,
      "InvokeDesktopSucceedCount": 1,
      "DesktopScenario": "Classic"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：StopInvocation - 停止脚本执行下一篇：RunCommand - 在云电脑中执行脚本