Listing Backups

Function

This API is used to query the backup list.

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}/ransomware/backup/{host_id}

**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
host_id	Yes	String	Definition Server ID. Constraints N/A Range The value can contain 0 to 64 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.
offset	Yes	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 N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints Mandatory. Range Value range: 10 to 200 Default Value 10
status	No	String	Definition Status Constraints N/A Range available: The backup is available. protecting: The backup is being protected. deleting: The backup is being deleted. restoring: The restoration in progress. error: The backup is abnormal. waiting_protect: The backup is waiting to be protected. waiting_delete: The backup is waiting to be deleted. waiting_restore: The backup is waiting to be restored. Default Value N/A
name	No	String	Definition Backup name. Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
last_days	No	Integer	Definition Query time range Constraints N/A Range Value range: 1-30 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
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 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 2,147,483,647.
data_list	Array of BackCopyByHostIdResponse objects	Definition Backup list. Range The value range is 0 to 200.

**Table 5** BackCopyByHostIdResponse
Parameter	Type	Description
backup_id	String	Definition Backup ID. Range The value can contain 0 to 65,535 characters.
backup_name	String	Definition Backup name. Range The value can contain 0 to 65,535 characters.
backup_status	String	Definition Backup status. Range The value can contain 0 to 65,535 characters.
create_time	Long	Definition Creation time. Range The value range is 0 to 2,147,483,647.
os_images_data	Array of ImageData objects	Definition ID list of images created using backups. Range The value range is 0 to 200.
backup_tag	Integer	Definition Backup ID. Range 0: scheduled period 1: ransomware encryption

**Table 6** ImageData
Parameter	Type	Description
image_id	String	Definition ID of the registered backup image Range The value can contain 0 to 256 characters.

Example Requests

Query information about the backup whose server ID is xxxxxx.

GET https://{endpoint}/v5/{project_id}/ransomware/backup/{host_id}?enterprise_project_id=all_granted_ep&host_id=xxxxxx

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "backup_id" : "id",
    "backup_name" : "name",
    "os_images_data" : [ {
      "image_id" : "image_id"
    } ]
  } ]
}