调用RunCommand在一台或多台云桌面中执行一段PowerShell或者Bat类型的脚本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | RunCommand |
系统规定参数。取值:RunCommand。 |
CommandContent | String | 是 | ZWNobyAxMjM= |
脚本的明文内容或者Base64编码后的内容。 脚本内容Base64编码后不能超过16 KB。 |
DesktopId.N | RepeatList | 是 | ecd-7w78ozhjcwa3u**** |
云桌面ID列表。N的取值范围:1~50。 如果指定了多台云桌面,只要有一台云桌面可以成功执行脚本,该API就能调用成功。当指定的多台云桌面均无法执行脚本时,您需要重新设置该参数。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 |
Type | String | 是 | RunPowerShellScript |
运维脚本的语言类型。取值范围:
|
Timeout | Long | 否 | 3600 |
执行脚本的超时时间,单位为秒。默认值:60。 当因为进程原因、缺失模块、缺失云助手客户端等原因无法运行脚本时,会出现超时现象。超时后,会强制终止脚本进程。 |
ContentEncoding | String | 否 | Base64 |
脚本内容的编码方式。取值范围:
默认值:PlainText。乱填或错填时,该取值会当作PlainText处理。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InvokeId | String | t-7d2a745b412b4601b2d47f6a768d**** |
脚本执行ID。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
示例
请求示例
https://ecd.cn-hangzhou.aliyuncs.com/?Action=RunCommand
&CommandContent=ZWNobyAxMjM=
&DesktopId.1=ecd-7w78ozhjcwa3u****
&RegionId=cn-hangzhou
&Type=RunPowerShellScript
&<公共请求参数>
正常返回示例
XML
格式
<RunCommandResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<InvokeId>t-7d2a745b412b4601b2d47f6a768d****</InvokeId>
</RunCommandResponse>
JSON
格式
{
"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"InvokeId":"t-7d2a745b412b4601b2d47f6a768d****"
}
错误码
访问错误中心查看更多错误码。