Help Center/ Workspace/ API Reference/ Workspace APIs/ Script/ Querying Script Execution Record Details

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

View PDF

Querying Script Execution Record Details

Function

Queries script execution record details.

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-records/{record_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
record_id	Yes	String	Script execution record ID.

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
id	String	Script execution record ID.
script_id	String	Script ID.
script_name	String	Script name.
script_task_id	String	Script execution task ID.
resource_id	String	Resource ID for script execution, for example, desktop ID.
resource_name	String	Resource name for script execution, for example, desktop name.
resource_type	String	Resource type, for example, DESKTOP.
start_time	DateTime	Start time of script execution.
end_time	DateTime	End time of script execution.
status	String	Script execution status.
execute_order	Integer	Execution batch (0: default value; 1: gray; 2: non-gray).
result_code	String	Error code.
reason	String	Cause.
output	String	Script execution output.

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 message.

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 message.

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 message.

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 message.

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 message.

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 message.

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 message.

Example Requests

None

Example Responses

Status code: 200

Response to a successful request.

{
  "id" : "sawafaw12414214awfa",
  "script_id" : "string",
  "script_name" : "string",
  "script_task_id" : "string",
  "resource_id" : "string",
  "resource_name" : "string",
  "resource_type" : "string",
  "start_time" : "2024-12-25T07:10:36.054Z",
  "end_time" : "2024-12-25T07:10:36.054Z",
  "status" : "string",
  "execute_order" : 0,
  "result_code" : "string",
  "reason" : "string",
  "output" : "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.