云桌面查询任务执行的详细情况

1. 接口描述

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

查询脚本任务执行的详细情况。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInvocationDetail。
Version	是	String	公共参数，本接口取值：2020-11-04。
Region	否	String	公共参数，本接口不需要传递此参数。
InstanceId	是	String	云桌面实例ID。示例值：cdi-234r32ad
InvokeId	是	String	任务ID。示例值：23sfc-324-s11
OutputLinesOffset	否	Integer	需要返回的任务输出行号起始索引。示例值：1
OutputLinesLimit	否	Integer	需要返回的任务输出行数。示例值：100
MergeOutputLines	否	Boolean	任务的输出内容是否合并成一个字符串。默认为true。示例值：false

3. 输出参数

参数名称	类型	描述
Detail	Invocation	实例上任务执行的详细情况。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务执行的详细情况

输入示例

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

{
    "InstanceId": "cdi-234r32ad",
    "OutputLinesOffset": 1,
    "OutputLinesLimit": 1,
    "InvokeId": "23sfc-324-s11"
}

输出示例

{
    "Response": {
        "Detail": {
            "Status": "Finished",
            "Output": {
                "Encoding": "PlainText",
                "Lines": [
                    "23radef"
                ],
                "AllLinesOffset": 1,
                "LinesOffset": 1,
                "AllLinesNum": 1,
                "LinesNum": 1
            },
            "InvokeId": "23sfc-324-s11",
            "ErrorCode": "",
            "ErrorInfo": ""
        },
        "RequestId": "a4c33d6d-d6a2-47d3-9a19-940ead9f8752"
    }
}

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	资源不存在。

查询任务执行的详细情况

本页目录：