用于查询云助手脚本的执行列表和状态。
接口说明
- 当您执行命令后,不代表命令一定成功执行,并且一定有预期的命令效果。您需要通过接口返回值来查看实际执行结果,以实际输出结果为准。
- 您可以查询最近 2 周的执行信息,执行信息的保留上限为 10 万条。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
InvokeId | string | 否 | 脚本进程执行 ID。 | t-hz0jdfwd9f**** |
CommandType | string | 否 | 脚本类型。取值范围:
| RunPowerShellScript |
InvokeStatus | string | 否 | 脚本执行的总执行状态。总执行状态取决于创建执行中的一台或多台云桌面的共同执行状态。取值范围:
默认值:Running。 | Finished |
DesktopId | string | 否 | 云桌面 ID。如果指定了云桌面,则查询该桌面所有的脚本执行记录。 | ecd-7w78ozhjcwa3u**** |
IncludeOutput | boolean | 否 | 是否在结果中返回脚本运行的输出信息。取值范围:
默认值:false。 | false |
ContentEncoding | string | 否 | 返回数据的编码方式。取值范围:
默认值:Base64。 | PlainText |
MaxResults | integer | 否 | 分页查询时每页行数。
| 10 |
NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL**** |
EndUserId | string | 否 | 用户 ID。 | test1 |
DesktopIds | array | 否 | 云桌面 ID 列表。DesktopId 即将弃用,请使用当前字段传递 DesktopId 列表信息。 | |
string | 否 | 云桌面 ID | ecd-84mztzatmipf2**** |
返回参数
示例
正常返回示例
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"
}
],
"InvokeDesktopCount": 0,
"InvokeDesktopSucceedCount": 0
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-13 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-05-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-10-18 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-09-29 | OpenAPI 入参发生变更 | 查看变更详情 |