Query Information of Multiple Backup Files

Query the detailed information of multiple backup files at the same time.

Request URL

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

Request parameters

Parameter Required Type Description
file_names Yes String The name(s) of backup file(s).
Note:

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.
backup_list Array<Backup_Info> The information of backup files.
Backup_Info
Parameter Type Description
file_name String The name of the backup file.
backup_time String The time when the backup is created.
memo String The remark of the backup file.

Examples

Request example

Query the detailed information of backup files (Name: Backup-X.17.0.10-20241025090454-local.bak & Backup-X.18.0.45-20250208112520-local.bak).

GET /openapi/v1.0/backup/query?access_token=xFMEN8G2cyy6fB38estExByguJTOGS9p&file_names=Backup-X.17.0.10-20241025090454-local.bak,Backup-X.18.0.45-20250208112520-local.bak HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "backup_list": [
        {
            "file_name": "Backup-X.17.0.10-20241025090454-local.bak",
            "backup_time": "2024/10/25 09:06:29",
            "memo": ""
        },
        {
            "file_name": "Backup-X.18.0.45-20250208112520-local.bak",
            "backup_time": "2025/02/08 11:27:15",
            "memo": ""
        }
    ]
}