Synchronizing a Backup

Function

This API is used to synchronize on-premises VMware backups.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v3/{project_id}/backups/sync

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
sync	Yes	Array of BackupSync objects	List of backups to be imported

**Table 4** BackupSync
Parameter	Mandatory	Type	Description
backup_id	Yes	String	Backup ID. For details about how to obtain the backup ID, see Obtaining a Backup ID.
backup_name	Yes	String	Backup name
bucket_name	Yes	String	Bucket name. The value can contain a maximum of 255 characters.
image_path	Yes	String	Backup's path on the storage unit.
resource_id	Yes	String	ID of the resource to be backed up. The resource must have been associated with the vault and can be backed up. For details about how to obtain the ID, see Querying Information About the Resources Associated with a Vault and Querying Protectable Resources.
resource_name	Yes	String	Backup object name
resource_type	Yes	String	Type of the resource to be backed up. The default value is OS::Native::Server. The options are as follows: OS::Native::Server: local server OS::VMware::Server: VMware server
created_at	Yes	Integer	Backup time, in seconds. For example, 1548898428.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
sync	Array of BackupSyncRespBody objects	Return information of the API for importing backups

**Table 6** BackupSyncRespBody
Parameter	Type	Description
backup_id	String	Backup ID. For details about how to obtain the backup ID, see Obtaining a Backup ID.
operation_log_id	String	Import task ID

Example Requests

Synchronizing an on-premises VMware backup

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/sync

{
  "sync" : [ {
    "backup_id" : "1f9e6b47-7655-4a19-b563-21b4ef023025",
    "resource_id" : "96f7512d-239d-3f31-80cf-d1ce041df9a6",
    "resource_name" : "resource_name",
    "resource_type" : "OS::Nova::Server",
    "bucket_name" : "1555230361623e4ce4700dab84b7d8169a5eaec05227d",
    "image_path" : "6abec15e-7baf-4d79-b5a9-6b98a2da7020/cfe0295c-5939-4b31-96cd-161b4725e7ad/cfe0295c-5939-4b31-96cd-161b4725e7ad",
    "created_at" : 1553587260,
    "backup_name" : "backup_name"
  } ]
}

Example Responses

Status code: 200

{
  "sync" : [ {
    "backup_id" : "1f9e6b47-7655-4a19-b563-21b4ef023025",
    "operation_log_id" : "154f0a9d-ba53-4e91-a3e2-a918710a9e0d"
  } ]
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Parent topic: Backups

Previous topic: Backups

Next topic: Querying a Specified Backup

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

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

Chatbot