Query Information of a Backup File

Request URL

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

Request parameters


Parameter	Required	Type	Description
file_name	Yes	String	The name of the backup file. Note: You can query backup file name 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.
backup	Array<Backup_Info>	The information of the backup file.

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 a backup file (Name: Backup-X.18.0.89-20250313132238-local.bak).

GET /openapi/v1.0/backup/get?access_token=xFMEN8G2cyy6fB38estExByguJTOGS9p&file_name=Backup-X.18.0.89-20250313132238-local.bak HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "backup": {
        "file_name": "Backup-X.18.0.89-20250313132238-local.bak",
        "backup_time": "2025/03/13 13:24:15",
        "memo": ""
    }
}