Obtaining All Backup Information

Function

URI

POST /v2/{project_id}/audit/{instance_id}/backups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. Restrictions: N/A Range: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. Default value: N/A
instance_id	Yes	String	Definition: Instance ID. The value can be obtained from the ID field of the API for querying the instance list. Restrictions: N/A Range: The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header. Restrictions: N/A Value range: Used by the IAM service to query the user token. Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
end_time	No	String	End time
page	Yes	Integer	Current page
size	Yes	Integer	Pagination size.
start_time	No	String	Start time, in yyyy-MM-dd HH:mm:ss format.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data_list	Array of BackupInfo objects	Backup file list
total_num	Long	Specifies the total number of records.

**Table 5** BackupInfo
Parameter	Type	Description
backup_task_fail_reason	String	Backup Failure Cause
backup_time	String	Backup time, in yyyy-MM-dd HH:mm:ss format.
deleted	Boolean	Marking deletion
end_time	String	Backup end time, in yyyy-MM-dd HH:mm:ss format.
file_size	Long	File size
file_size_unit	String	Unit of the file size. Byte KB MB GB
id	String	Backup ID.
mode	String	Backup modes AUTO: automatic backup
name	String	backup_name
percentage	Integer	Backup progress
progress	String	Progress CLEAN_AFTER_FAILED: The data fails to be cleared. DELETING: The instance is being deleted. DELETED: The instance was deleted. DELETE_FAIL: The deletion fails. RESTORING_WAITING: The service is waiting to be restored. RESTORING: The VM is being restored. RESTORED: restored RESTORE_FAIL: The restoration fails. BACKUP_WAITING: Backup is waiting. FILE_UPLOAD_WAITING: The backup file is waiting to be uploaded. FILE_UPLOADING: The file is being uploaded. AUTO_BACKUPING: Automatic backup is in progress. AUTO_BACKUPED: The automatic backup is complete. AUTO_BACKUP_FAIL: indicates that the automatic backup fails. MANUAL_BACKUPING: The manual backup is in progress. MANUAL_BACKUP_FAIL: Manual backup failed. ISAP_WAITING: ISAP is waiting for backup. ISAP_BACKUPING: The ISAP is being backed up. ISAP_BACKUPED: ISAP backup succeeded. ISAP_BACKUP_FAIL: ISAP backup failed. ISAP_FILE_UPLOAD_WAITING: The ISAP is waiting to upload the backup file. ISAP_FILE_UPLOADING: The ISAP is uploading files.
restore_task_fail_reason	String	Restoration Failure Cause
sha256	String	File SHA256
start_time	String	Backup start time, in yyyy-MM-dd HH:mm:ss format.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 7** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 9** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 11** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 13** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

/v2/{project_id}/audit/{instance_id}/backups

{
  "page" : 1,
  "size" : 10
}

Example Responses

Status code: 200

{
  "total_num" : 1,
  "data_list" : [ {
    "id" : "XwRQyJgBhN3UjKKc3yhJ",
    "name" : "auto_backup_20250820-00_00~23_59",
    "backup_time" : "2025-08-20 16:30:00",
    "file_size" : 20,
    "file_size_unit" : "Byte",
    "mode" : "AUTO",
    "start_time" : "2025-08-19 16:00:00",
    "end_time" : "2025-08-20 15:59:59",
    "percentage" : 0,
    "deleted" : false,
    "progress" : "RESTORED",
    "backup_task_fail_reason" : null,
    "restore_task_fail_reason" : null,
    "sha256" : "59869db34853933b239f1e2219cf7d431da006aa919635478511fabbfc8849d2"
  } ]
}