Get Backup Status of a Backup File

Get the backup status of a specific backup file.

Request URL

GET {base_url}/{api_path}/backup/getstatus?access_token={access_token}

Request parameter

Parameter Required Type Description
file_name Yes Integer The name of the backup file.
Note: You can query the backup file ID using Search Specific Backup File.

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.
status String The backup status of backup file.
  • success
  • failed
  • processing

Examples

Request example

Query the backup status of a backup file (Name: Backup-X.20.0.X-20250827140801-local.bak).

GET /openapi/v1.0/backup/getstatus?access_token=bnmkmFeDCGp1HlKRuMGMUxF1ZA76qer1&file_name=Backup-X.20.0.X-20250827140801-local.bak HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "status": "success"
}