Help Center/ Workspace/ API Reference/ Workspace APIs/ Script/ Executing Scripts or Commands in Batches

Updated on 2026-02-10 GMT+08:00

View PDF

Executing Scripts or Commands in Batches

Function

Executes scripts or commands in batches.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:scripts:execute	Write	script *	-	-	-
workspace:scripts:execute	Write	desktop *	-	-	-

URI

POST /v2/{project_id}/script-executions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
gray_count	No	Integer	Number of gray resources.
resource_type	No	String	Resource type, for example, DESKTOP.
gray_resource_ids	No	Array of strings	Resources for gray script execution.
gray_fail_threshold	No	Integer	Gray failure threshold. When the threshold is reached, the system stops executing the next batch of scripts. The value is less than the value of gray_count.
resource_ids	No	Array of strings	Resources for script execution.
script_ids	No	Array of strings	Executed scripts.
execution_timeout	No	Integer	Timeout interval for executing a script, in minute.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_id	String	Script execution task ID.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 405

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 503

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Example Requests

{
  "resource_type" : "DESKTOP",
  "resource_ids" : [ "eb4ccd3e-170f-48ec-9715-ec0457df376f" ],
  "script_ids" : [ "923438311391891456" ],
  "execution_timeout" : 10
}

Example Responses

Status code: 200

Response to the request for executing scripts in batches.

{
  "task_id" : "0000000059071dbc01591661d3990019"
}

Status Codes

Status Code	Description
200	Response to the request for executing scripts in batches.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	Service unavailable.