Restoring Data Using a Backup

This API is used to restore data using a 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.

POST /v5/{project_id}/ransomware/duplication/{backup_id}/restore

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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
server_id	No	String	Definition ID of the target VM to be restored. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
power_on	No	Boolean	Definition Whether to start the device after the restoration. It is started by default. Constraints N/A Range true false Default Value true
mappings	No	Array of BackupRestoreServerMappingInfo objects	Definition Mapping relationship for restoration. This parameter is mandatory for VM restoration and optional for disk restoration. Range N/A

**Table 5** BackupRestoreServerMappingInfo
Parameter	Mandatory	Type	Description
backup_id	No	String	Definition Volume backup ID, which can be obtained from the console or via the API for querying a specified backup. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
volume_id	No	String	Definition ID of the disk to which data is restored. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A

Status code: 200

Request succeeded.

None

Query the whitelist of sensitive information file paths of an image.

POST https://{endpoint}/v5/{project_id}/ransomware/duplication/{backup_id}/restore

None

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.