云桌面 WORKSPACE-桌面池批量执行脚本:请求参数

时间:2024-12-27 15:06:31

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

script_ids

Array of strings

执行的脚本id列表,与command二选一。

gray_count

Integer

首批执行的桌面数量,优先级高于gray_desktop_ids。

gray_desktop_ids

Array of strings

首批执行的桌面id列表,优先级低于gray_count。

gray_fail_threshold

Integer

灰度失败阈值,灰度执行失败次数达到该值时,不执行下一批任务。

pre_start

String

执行脚本前置步骤。

post_finish

String

执行脚本完成后置步骤,当前支持关机(stop)、重启(reboot)。

command_content

String

执行的命令行,与script_ids二选一。

command_type

String

命令行类型,执行命令行时必传。

  • POWERSHELL:WINDOWS系统使用。

  • BAT:WINDOWS系统使用。

  • SHELL:LINUX系统使用。

execution_timeout

Integer

执行脚本的超时时间,单位分钟,默认1分钟。

support.huaweicloud.com/api-workspace/ExecuteDesktopPoolScript.html