Querying Script Execution Records
Function
Queries script execution records.
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
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_id |
No |
Array of strings |
Resource IDs of script execution. |
resource_group_id |
No |
Array of strings |
Resource group ID of script execution. |
script_id |
No |
Array of strings |
ID of the executed script. |
script_name |
No |
Array of strings |
Name of the executed script. |
status |
No |
String |
Script execution status. |
is_first_order |
No |
Boolean |
Whether it is the first-batch execution. |
script_task_id |
No |
String |
Script execution task ID. |
task_type |
No |
String |
Task type of the execution record (SCRIPT or COMMAND). |
show_history |
No |
Boolean |
Whether to query historical records. The default value is false. If the value is true, both resource_id and script_id must be transferred. |
execute_time_start |
No |
String |
Start time of the query by execution time. If this parameter is specified, all execution 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 execution records before this time are returned. A time example is 2021-10-01T12:00:00Z. |
Request 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
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number. |
script_records |
Array of ScriptRecordSimpleInfo objects |
Script execution records. |
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. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 405
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error message. |
Status code: 503
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_records" : [ { "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:49.357Z", "end_time" : "2024-12-25T07:10:49.357Z", "status" : "string", "execute_order" : 0, "result_code" : "string", "reason" : "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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot