Querying the List of Backups That Can Be Rolled Back

Function

This API is used to query the list of backups available for rollback.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/vulnerability/backup/backups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
vul_id	Yes	String	Definition Vulnerability ID. Constraints N/A Range Length: 0 to 256 characters Default Value N/A
host_id	Yes	String	Definition Host ID. Constraints N/A Range Length: 0 to 256 characters Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 10,000.
data_list	Array of data_list objects	Definition Backup list Range N/A

**Table 5** data_list
Parameter	Type	Description
backup_time	Long	Definition Backup time (timestamp, in milliseconds). Range The value range is 0 to 9,223,372,036,854,775,807.
backup_id	String	Definition Backup ID. Range Length: 1 to 128 characters
backup_name	String	Definition Backup name. Range Length: 1 to 64 characters
status	String	Definition Backup status Range available: available protecting: backup in progress deleting: deleting restoring: restoring error: error waiting_protect: to be backed up waiting_delete: to be deleted waiting_restore: to be restored

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "backup_time" : 11,
    "backup_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
    "backup_name" : "hss_fix_vul_backup",
    "status" : "available"
  } ]
}