云桌面执行脚本任务

1. 接口描述

接口请求域名： cvd.tencentcloudapi.com 。

在指定的云桌面实例上执行脚本任务。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：RunCommand。
Version	是	String	公共参数，本接口取值：2020-11-04。
Region	否	String	公共参数，本接口不需要传递此参数。
InstanceId	是	String	云桌面实例ID。示例值：cdi-nqj1mqcjmirynr7
Content	是	String	执行的脚本内容，编码方式由ContentEncoding指定。 <li>脚本内容在Base64编码后的大小不能超过16 KB。示例值：cGluZyAtbiA1IDEyNy4wLjAuMQ==
Type	是	String	脚本种类。取值有：<li>PowerShellScript Powershell脚本 <li>BatScript Bat脚本示例值：BatScript
WaitUntilDone	否	Boolean	是否同步等待脚本的执行结果。<li>false为异步模式，通过此接口触发任务的执行，之后异步获取执行结果。默认为false。此为推荐的模式。<li>true为同步等待执行结果，只有当脚本执行时间在4秒之内时，才适合将该参数置为true。如果接口返回时任务尚未执行完毕的话，也需要通过异步接口来获取执行结果。示例值：false
ContentEncoding	否	String	Content的编码。<li>Base64 Base64编码。默认为Base64 示例值：Base64
MergeOutputLines	否	Boolean	任务的输出内容是否合并成一个字符串。<li>true表示所有的输出行拼接在一起。默认为true。<li>false表示输出内容通过数组返回,数组的每一个元素为一行。示例值：false
RunAs	否	String	执行任务的用户ID。<li>由SYSTEM身份执行。此场景下不需要指定该字段，这是默认情况。<li>需要以绑定到实例的用户执行任务，通过该字段指定用户ID。 <li>匿名访问，需要以实际登录系统的用户执行的场景，该字段填实例ID。示例值：userid
RunForeground	否	Boolean	任务是否为前台运行。仅在RunAs场景下有效。仅当任务会呼起图形界面时有意义。<li>true表示用户可以看到图形窗口。<li>false表示图形窗口不可见。默认为false。示例值：false

3. 输出参数

参数名称	类型	描述
InvokeId	String	本次任务对应的任务ID。方便异步查询执行状态。示例值：cdi-nqj1mqcjmirynr7-ecdfe348-cc7b-4594-98d6-37cf5f84969f
Detail	Invocation	执行详细情况。WaitUntilDone为true，在接口返回时的执行状态。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 在指定的云桌面实例上执行脚本任务

输入示例

POST / HTTP/1.1
Host: cvd.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunCommand
<公共请求参数>

{
    "InstanceId": "cdi-nqj1mqcjmirynr7",
    "Content": "cGluZyAtbiA0IDEyNy4wLjAuMQ==",
    "WaitUntilDone": true,
    "Type": "PowerShellScript",
    "ContentEncoding": "Base64"
}

输出示例

{
    "Response": {
        "Detail": {
            "Status": "Finished",
            "Output": {
                "Encoding": "PlainText",
                "Lines": [
                    "\n"
                ],
                "AllLinesOffset": 1,
                "LinesOffset": 1,
                "AllLinesNum": 1,
                "LinesNum": 1
            },
            "InvokeId": "cdi-nqj1mqcjmirynr7-ecdfe348-cc7b-4594-98d6-37cf5f84969f",
            "ErrorCode": "",
            "ErrorInfo": ""
        },
        "RequestId": "a4c33d6d-d6a2-47d3-9a19-940ead9f8752",
        "InvokeId": "cdi-nqj1mqcjmirynr7-ecdfe348-cc7b-4594-98d6-37cf5f84969f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.SystemError	信令执行时发生错误,建议重试。
InvalidParameterValue	参数取值错误。
ResourceNotFound	资源不存在。

执行脚本任务

本页目录：