文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面池/ 查询桌面池的脚本执行任务列表
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

查询桌面池的脚本执行任务列表

功能介绍

桌面池的脚本执行任务列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/desktop-pools/script-execution-tasks/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

desktop_pool_id

否

String

桌面池id。

script_id

否

String

脚本id。

script_name

否

String

脚本名称。

status

否

String

执行情况。SUCCESS：成功，FAILED：失败，RUNNING：执行中，WAITING：等待。

task_type

否

String

查询的任务类型。支持SCRIPT、COMMAND。

offset

否

Integer

用于分页查询，查询的起始记录序号，从0开始。

limit

否

Integer

用于分页查询，返回桌面数量限制。取值范围0-100，默认值是10。

execute_time_start

否

String

按执行时间查询的起始时间。指定该参数后，返回的结果为此时间之后的所有任务记录。时间格式如：“2021-10-01T12:00:00Z”。

execute_time_end

否

String

按执行时间查询的终止时间。指定该参数后，返回的结果为此时间之前的所有任务记录。时间格式如：“2021-10-01T12:00:00Z”。

task_id

否

Array of strings

任务id。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

script_execution_tasks

Array of ScriptExecutionTask objects

脚本执行任务列表。

total_count

Integer

总数。
表5 ScriptExecutionTask

参数

参数类型

描述

id

String

任务id。

desktop_pool_id

String

桌面池id。

desktop_pool_name

String

桌面池名称。

scripts

Array of Script objects

脚本信息列表。

command_content

String

执行的命令行。

command_type

String

命令行类型。

  • POWERSHELL：WINDOWS系统使用。

  • BAT：WINDOWS系统使用。

  • SHELL：LINUX系统使用。

start_time

String

任务开始时间，格式为：yyyy-MM-ddTHH:mm:ssZ。

end_time

String

任务结束时间，格式为：yyyy-MM-ddTHH:mm:ssZ。

status

String

任务状态，值含：

  • FINISH：已完成。

  • FAILED：失败。

  • RUNNING：运行中。

  • INIT： 初始化。

success_num

Integer

成功数量。

failed_num

Integer

失败数量。

skip_num

Integer

跳过数量。
表6 Script

参数

参数类型

描述

id

String

脚本id。

name

String

脚本名称。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

/v2/0bec5db98280d2d02fd6c00c2de791ce/desktops-pools/script-execution-tasks/detail

响应示例

无

状态码

状态码

描述

200

正常

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 桌面池