RunCommand - 在云电脑中执行脚本

更新时间:
复制为 MD 格式

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

调试

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

调试

授权信息

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

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

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecd:RunCommand

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

Type

string

运维脚本的语言类型。

枚举值:

  • RunPowerShellScript :

    运行 PowerShell 脚本

  • RunBatScript :

    运行 Bat 脚本

RunPowerShellScript

CommandContent

string

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

说明

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

ipconfig

Timeout

integer

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

3600

ContentEncoding

string

脚本内容的编码方式。

说明

若传入的值不在枚举值范围内,则一律作为传入PlainText处理。

枚举值:

  • Base64 :

    Base64 编码

  • PlainText :

    不编码,采用明文传输 [默认值]

Base64

DesktopId

array

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

string

云电脑 ID。

ecd-7w78ozhjcwa3u****

EndUserId

string

终端用户的 ID,若此参数不为空,则会以终端用户的权限执行命令。

说明

该用户需要在云电脑上存在会话记录(云电脑开机后有过登录及连接行为,且连接时未被其他用户抢占)。Linux 云电脑不支持该参数。

alice

CommandRole

string

返回参数

名称

类型

描述

示例值

object

返回对象。

InvokeId

string

脚本执行 ID。可以调用 DescribeInvocations 并传入该值来查询脚本执行状态。

t-hz01qgsqj2n****

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情