- 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.
Before You Start
Overview
Welcome to Volume Backup Service API Reference. Volume Backup Service (VBS) provides snapshot-based data protection for Elastic Volume Service (EVS) disks.
VBS secures your data, even if an EVS disk is faulty or encounters a logical error, for example, accidental deletion, hacker attacks, and virus infection. It allows you to easily back up your data and use these backups to restore data.
You can use APIs provided in this document to perform operations on VBS, such as creating a backup, deleting a backup, or creating a policy. For details about all supported operations, see API Overview.
Before calling VBS APIs, ensure that you have fully understood relevant concepts. For details, see Service Overview.
VBS APIs are only available to existing users. If you are new to the cloud, use CBR and CBR APIs.
API Calling
VBS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.
Endpoints
An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of VBS, see Regions and Endpoints.
Constraints
For more constraints, see the description of the specific API.
Concepts
- Account
An account is created upon successful signing up. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, which should not be used directly to perform routine management. To ensure account security, create Identity and Access Management (IAM) users and grant them permissions for routine management.
- User
An IAM user is created by an account in IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).
API authentication requires information such as the account name, username, and password.
- Region
Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.
For details, see Region and AZ.
- AZ
An AZ comprises of one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Computing, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ high-availability systems.
- Project
A project corresponds to a region. Default projects are defined to group and physically isolate resources (including computing, storage, and network resources) across regions. Users can be granted permissions in a default project to access all resources under their accounts in the region associated with the project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.
Figure 1 Project isolation model - Enterprise project
Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.
For details about enterprise projects and about how to obtain enterprise project IDs, see Enterprise Management User Guide.
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