Query an Archival Log

Retrieve the details of an archival log.

Request URL

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

Request parameters

Parameter Required Type Description
id Yes Integer The ID of the archival log.
Note: You can obtain the archival log ID using the Search Archival Logs interface.

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.
data Object<Archival_Log> The archival log information.
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/get?id=37&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "data": {
    "id": 37,
    "name": "9999",
    "file_type": "backup_files",
    "execution_time": "2026/08/19 16:12:47",
    "execution_result": "success"
  }
}