Help Center/ Workspace/ API Reference/ Workspace APIs/ Script/ Querying Script Tasks

Updated on 2025-07-14 GMT+08:00

View PDF

Querying Script Tasks

Function

Queries script tasks.

Debugging

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

URI

GET /v2/{project_id}/script-execution-tasks

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Query offset. The default value is 0.
limit	No	Integer	The number of records for each query ranges from 1 to 100. The default value is 10.
resource_group_id	No	Array of strings	Resource group ID of script execution.
script_id	No	String	Script ID.
script_name	No	String	Script name.
status	No	String	Execution status.
resource_group_type	No	String	Resource group type.
task_id	No	Array of strings	Script execution task ID.
task_type	No	String	Task type (SCRIPT or COMMAND).
execute_time_start	No	String	Start time of the query by execution time. If this parameter is specified, all task records after this time are returned. A time example is 2021-10-01T12:00:00Z.
execute_time_end	No	String	End time of the query by execution time. If this parameter is specified, all task records before this time are returned. A time example is 2021-10-01T12:00:00Z.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number.
script_tasks	Array of ScriptTaskInfo objects	Script tasks.

**Table 5** ScriptTaskInfo
Parameter	Type	Description
id	String	Script task ID.
task_scripts	Array of task_scripts objects	Scripts.
resource_type	String	Resource type, for example, DESKTOP.
resource_ids	Array of strings	Resource IDs of script execution.
gray_resource_ids	Array of strings	Resource IDs for batch gray execution.
success_num	Integer	Number of successful execution records in a task.
failed_num	Integer	Number of failed execution records in a task.
skip_num	Integer	Number of skipped execution records in a task.
start_time	DateTime	Start time of script execution.
end_time	DateTime	End time of script execution.
status	String	Task result.

**Table 6** task_scripts
Parameter	Type	Description
id	String	Script ID.
name	String	Script name.

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 405

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

Status code: 500

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

Status code: 503

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

Example Requests

None

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 0,
  "script_tasks" : [ {
    "id" : "sawafaw12414214awfa",
    "task_scripts" : [ {
      "id" : "string",
      "name" : "string"
    } ],
    "resource_type" : "string",
    "resource_ids" : [ "string" ],
    "gray_resource_ids" : [ "string" ],
    "success_num" : 0,
    "failed_num" : 0,
    "skip_num" : 0,
    "start_time" : "2024-12-25T07:11:02.540Z",
    "end_time" : "2024-12-25T07:11:02.540Z",
    "status" : "string"
  } ]
}

Status Codes

Status Code	Description
200	Response to a successful request.
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, see the error code description.
503	Service unavailable.