文档

RunCommand - 在云桌面中执行脚本

在一台或多台Windows操作系统云桌面中执行一段PowerShell或者Bat类型的脚本。

调试

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

授权信息

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

请求参数

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

地域 ID。

cn-hangzhou
Typestring

运维脚本的语言类型。取值范围:

  • RunBatScript
  • RunPowerShellScript
RunPowerShellScript
CommandContentstring

脚本的明文内容或者 Base64 编码后的内容。
脚本内容 Base64 编码后不能超过 16 KB。

说明 若为 Base64 编码后的脚本内容,则参数 ContentEncoding 必须配置为 Base64。
ipconfig
Timeoutlong

执行脚本的超时时间,单位为秒。默认值:300。
当因为进程原因、缺失模块、缺失云助手客户端等原因无法运行脚本时,会出现超时现象。超时后,会强制终止脚本进程。

3600
ContentEncodingstring

脚本内容的编码方式。取值范围:

  • PlainText:不编码,采用明文传输。
  • Base64:Base64 编码。

默认值:PlainText。乱填或错填时,该取值会当作 PlainText 处理。

Base64
DesktopIdarray

云桌面 ID 列表。N 的取值范围:1~50。
如果指定了多台云桌面,只要有一台云桌面可以成功执行脚本,该 API 就能调用成功。当指定的多台云桌面均无法执行脚本时,您需要重新设置该参数。

string

云桌面 ID。

ecd-7w78ozhjcwa3u****
EndUserIdstring

终端用户的 ID,若此参数不为空,则会以终端用户的权限执行命令。注:该用户需要在云电脑上存在会话记录(云电脑开机后有过登录及连接行为,且连接时未被其他用户抢占),且 Linux 云电脑不支持该参数。

User1

返回参数

名称类型描述示例值
object

返回对象。

InvokeIdstring

脚本执行 ID。

t-hz01qgsqj2n****
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

{
  "InvokeId": "t-hz01qgsqj2n****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-29OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:EndUserId