文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 脚本/ 批量执行脚本或命令
更新时间:2024-12-27 GMT+08:00
分享

批量执行脚本或命令

功能介绍

批量执行脚本或命令。

调试

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

URI

POST /v2/{project_id}/script-executions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

gray_count

Integer

灰度资源数量。

resource_type

String

资源类型,如桌面(DESKTOP)。

gray_resource_ids

Array of strings

灰度执行脚本的资源列表。

gray_fail_threshold

Integer

灰度失败阈值,达到阈值后停止进行下一批资源执行脚本,小于gray_count。

resource_ids

Array of strings

执行脚本的资源列表。

execution_timeout

Integer

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

task_id

String

执行脚本的任务ID。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

{
  "gray_count" : 1,
  "resource_type" : "desktop",
  "resource_ids" : [ {
    "resource_id" : "0000000059071dbc01591661d3990019"
  } ],
  "script_ids" : [ {
    "script_id" : "0000000059071dbc01591661d3990019"
  } ]
}

响应示例

状态码: 200

批量执行脚本响应。

{
  "task_id" : "0000000059071dbc01591661d3990019"
}

状态码

状态码

描述

200

批量执行脚本响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

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

503

服务不可用。

错误码

请参见错误码

相关文档