Search Archival Logs

Request URL

GET {base_url}/{api_path}/archival_logs/search?access_token={access_token}

Request parameters


Parameter	Required	Type	Description
page	No	Integer	Define which page is displayed.
page_size	No	Integer	Define how many records per page.
search_value	No	String	The keyword used to search archive task names.
file_type	No	String	The type of archived files to filter by. Valid value: `recording_files` `backup_files`
execution_result	No	String	The execution result to filter by. Valid value: `success`: The archive task was executed successfully. `failed`: The archive task failed. `retrying`: The archive task is being retried.
sort_by	No	String	Define the sorting field. Valid value: `id`
order_by	No	String	Define the display order. Valid value: `asc`: Ascending order. `desc`: Descending order.

Response parameters


Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.
total_number	Integer	The total number of archival logs matching the search criteria.
data	Array<Archival_Log>	The list of archival logs matching the search criteria.

Archival_Log


Parameter	Type	Description
id	Integer	The ID of the archival log.
name	String	The name of the archive task that generated the log.
file_type	String	The type of archived files. `recording_files` `backup_files`
execution_time	String	The time when the archive task was executed.
execution_result	String	The execution result of the archive task. `success`: The archive task was executed successfully. `failed`: The archive task failed. `retrying`: The archive task is being retried.

Example

Request example

GET /openapi/v1.0/archival_logs/search?page=1&page_size=2&file_type=backup_files&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "total_number": 11,
  "data": [
    {
      "id": 35,
      "name": "111",
      "file_type": "backup_files",
      "execution_time": "2026/02/01 16:12:00",
      "execution_result": "success"
    },
    {
      "id": 33,
      "name": "111",
      "file_type": "backup_files",
      "execution_time": "2026/01/31 16:12:00",
      "execution_result": "success"
    }
  ]
}