Fetching Specific Backup Details

This API is used to query a specific backup.

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.

GET /v5/{project_id}/ransomware/backup/{backup_id}/detail

**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
backup_id	Yes	String	Definition Backup 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.

**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

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Definition Backup ID. Range The value can contain 0 to 65,535 characters.
name	String	Definition Backup name. Range The value can contain 0 to 65,535 characters.
image_type	String	Definition Backup type. Range The value can contain 0 to 65,535 characters.
vault_id	String	Definition ID of the vault where the backup resides Range The value can contain 0 to 65,535 characters.
created_at	Long	Definition Creation time. Range The value range is 0 to 9,223,372,036,854,775,807.
status	String	Definition Backup status. Range The value can contain 0 to 65,535 characters.
resource_size	Integer	Definition Resource size. Range The value range is 0 to 2,147,483,647.
resource_id	String	Definition Resource ID, which corresponds to the server ID. Range The value can contain 0 to 65,535 characters.
resource_type	String	Definition Resource type. Range The value can contain 0 to 65,535 characters.
resource_name	String	Definition Resource name, which corresponds to the server name. Range The value can contain 0 to 65,535 characters.
children	Array of BackupResp objects	Definition Sub-backup is the volume backup information. Range The value can contain 0 to 65,535 characters.

**Table 5** BackupResp
Parameter	Type	Description
id	String	Definition Volume backup ID. Range The value can contain 0 to 65,535 characters.
name	String	Definition Disk backup name. Range The value can contain 0 to 65,535 characters.
image_type	String	Definition Backup type. Range The value can contain 0 to 65,535 characters.
vault_id	String	Definition ID of the vault where the backup resides Range The value can contain 0 to 65,535 characters.
status	String	Definition Backup status. Range The value can contain 0 to 65,535 characters.
resource_size	Integer	Definition Creation time. Range The value range is 0 to 2,147,483,647.
resource_id	String	Definition Resource ID, which corresponds to the server ID. Range The value can contain 0 to 65,535 characters.
resource_type	String	Definition Resource type. Range The value can contain 0 to 65,535 characters.
resource_name	String	Definition Resource name, which corresponds to the server name. Range The value can contain 0 to 65,535 characters.

Querying Information About a Specified Backup (ID: xxxxxx)

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

Status code: 200

Request succeeded.

{
  "id" : "id",
  "name" : "name",
  "resource_id" : "resource_id",
  "children" : [ {
    "id" : "id_children",
    "name" : "dev1"
  } ]
}

Status Code	Description
200	Request succeeded.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.