- Service Overview
- Getting Started
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
API Description
-
VBS Backups
- Creating a VBS Backup
- Deleting a VBS Backup (Deprecated)
- Restoring a Disk Using a VBS Backup
- Creating a VBS Backup (Native OpenStack API) (Deprecated)
- Querying Summary Information About VBS Backups (Native OpenStack API) (Deprecated)
- Querying Details About VBS Backups (Native OpenStack API) (Deprecated)
- Querying Details About a VBS Backup (Native OpenStack API) (Deprecated)
- Querying the Job Status
- Deleting a VBS Backup (Native OpenStack API) (Deprecated)
- Restoring a Disk Using a VBS Backup (Native OpenStack API) (Deprecated)
- Sharing a Backup
- Canceling Sharing of a Backup
- Querying Backup Sharings
- Counting Backup Sharings
- Querying Details About a Backup Sharing
-
Backup Policies
- Creating a Backup Policy
- Querying Backup Policies
- Modifying a Backup Policy
- Deleting a Backup Policy
- Associating Resources with a Backup Policy
- Disassociating Resources from a Backup Policy
- Executing a Backup Policy At Once
- Enabling or Disabling a Backup Policy
- Querying Backup Jobs Triggered by a Backup Policy
- Adding a Tag to a Backup Policy
- Removing a Tag from a Backup Policy
- Querying All Backup Policy Tags
- Querying Tags of a Backup Policy
- Batch Updating or Removing Tags of a Backup Policy
- Querying Backup Policies by Tag
-
VBS Backups
- Permissions Policies and Supported Actions
- Appendix
-
FAQs
- What Is Volume Backup Service?
- What Is a Backup Policy?
- What Are the Differences Between Backup and Disaster Recovery?
- How Do I Purchase and Renew VBS?
- What Are the Differences Between CSBS and VBS?
- Does VBS Support Simultaneous Backup of All EVS Disks on a Server?
- Do I Need to Stop the Server Before Backing Up EVS Disks on a Server Using VBS?
- How Long Does VBS Take to Back Up an EVS Disk?
- Does VBS Support Cross-Region Backup and Restoration?
- Do I Need to Stop the Server Before Restoring EVS Disk Data with a VBS Backup?
- What Is the Charging Mode of EVS Disks Created with a VBS Backup?
- Why Are CSBS Backups Displayed on the VBS Backup Page?
- Can a VBS Backup of a System Disk Be Used to Restore the System Disk of an ECS?
- Can I Use a VBS Backup to Restore an EVS Disk Whose Capacity Has Been Expanded?
- Is There a Quota Limit on the Number of Backups?
- What Can I Do In Case of Exceptions in VBS?
- Why Add Tags to a VBS Backup or Backup Policy?
- Does Backup Can Be Performed Several Times a Day?
- Can a Disk Only Be Associated With One Policy?
- What Are Full Backup and Incremental Backup?
- What Are the Differences Between Backups and Snapshots?
- Why Is the Remaining Space Not Changed After a Backup Is Deleted?
- Why Is the Disk Space Usage Displayed in the File System Different from the Backup Size?
- Why Does the Retention Rule Not Take Effect After Being Modified?
- How Do I Disable Automatic Backup?
- Videos
- Glossary
-
More Documents
-
User Guide (Paris)
- Service Overview
- Getting Started
- Operation Guide
-
FAQs
- Does VBS Support Simultaneous Backup of All EVS Disks on a Server?
- Do I Need to Stop the Server Before Backing Up EVS Disks on a Server Using VBS?
- Does VBS Support Cross-Region Backup and Restoration?
- Do I Need to Stop the Server Before Restoring EVS Disk Data with a VBS Backup?
- What Is the Charging Mode of EVS Disks Created with a VBS Backup?
- Why Are CSBS Backups Displayed on the VBS Backup Page?
- Can a VBS Backup of a System Disk Be Used to Restore the System Disk of an ECS?
- Can I Use a VBS Backup to Restore an EVS Disk Whose Capacity Has Been Expanded?
- Is There a Quota Limit on the Number of Backups?
- What Can I Do In Case of Exceptions in VBS?
- Can a Disk Only Be Associated With One Policy?
- What Are Full Backup and Incremental Backup?
- What Are the Differences Between Backups and Snapshots?
- Why Is the Remaining Space Not Changed After a Backup Is Deleted?
- Troubleshooting Cases
- Change History
-
API Reference (Paris)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
API Description
-
VBS Backups
- Creating a VBS Backup
- Deleting a VBS Backup (Deprecated)
- Restoring a Disk Using a VBS Backup
- Creating a VBS Backup (Native OpenStack API)
- Querying Summary Information About VBS Backups (Native OpenStack API)
- Querying Details About VBS Backups (Native OpenStack API)
- Querying Details About a VBS Backup (Native OpenStack API)
- Querying the Job Status
- Deleting a VBS Backup (Native OpenStack API)
- Restoring a Disk Using a VBS Backup (Native OpenStack API)
-
Backup Policies
- Creating a Backup Policy
- Querying Backup Policies
- Modifying a Backup Policy
- Deleting a Backup Policy
- Associating Resources with a Backup Policy
- Disassociating Resources from a Backup Policy
- Executing a Backup Policy At Once
- Enabling or Disabling a Backup Policy
- Querying Backup Jobs Triggered by a Backup Policy
-
VBS Backups
- Appendix
- Change History
-
User Guide (Paris)
- General Reference
Copied.
Sharing a Backup
Function
This API is used to share a backup to another project.
URI
- URI format
- Parameter description
Parameter
Mandatory
Description
project_id
Yes
Project ID
For details about how to obtain the project ID, see Obtaining a Project ID.
Request
- Parameter description
Parameter
Mandatory
Type
Description
shared
Yes
dict
Information about the backup sharing
backup_id
Yes
string
ID of the backup to be shared
to_project_ids
Yes
list<string>
IDs of projects with which the backup is shared
- Example request
{ "shared": { "to_project_ids": [ "722513ed0a324dadaabe5b2d0fe848c9", "722513ed0a324dadaabe5b2d0fe84919" ], "backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d" } }
Response
- Parameter description
Parameter
Mandatory
Type
Description
shared
Yes
dict
Information about the backup sharing
backup_id
Yes
string
Backup ID
id
Yes
string
Backup sharing ID
to_project_id
Yes
string
ID of the project to which the backup is shared
from_project_id
Yes
string
ID of the project that shares the backup
created_at
Yes
string
Creation time of the backup sharing
updated_at
Yes
string
Update time of the backup sharing
deleted
Yes
string
Whether the backup sharing has been canceled
deleted_at
Yes
string
Deletion time
- Example response
{ "shared": [ { "backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d", "deleted": null, "created_at": null, "updated_at": null, "to_project_id": "722513ed0a324dadaabe5b2d0fe848c9", "from_project_id": "c13f5220dc1949b0b741ea81a7cd5554", "deleted_at": null, "id": "8332443e-9866-41d8-8a58-a898cf5db030" } ] }
Status Codes
- Normal
- Abnormal
Status Code
Description
400 Bad Request
The server failed to process the request.
401 Unauthorized
You must enter the username and password to access the requested page.
403 Forbidden
You are forbidden to access the requested page.
404 Not Found
The server could not find the requested page.
405 Method Not Allowed
You are not allowed to use the method specified in the request.
406 Not Acceptable
The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required
You must use the proxy server for authentication so that the request can be processed.
408 Request Timeout
The request timed out.
409 Conflict
The request could not be processed due to a conflict.
500 Internal Server Error
Failed to complete the request because of an internal service error.
501 Not Implemented
Failed to complete the request because the server does not support the requested function.
502 Bad Gateway
Failed to complete the request because the request is invalid.
503 Service Unavailable
Failed to complete the request because the service is unavailable.
504 Gateway Timeout
A gateway timeout error occurred.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot