- 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.
Authentication
- Token authentication: Requests are authenticated using tokens.
- AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authentication is recommended because it is more secure than token authentication.
Token Authentication
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the Obtaining User Token API.
VBS is a project-level service. When you call the API, set auth.scope in the request body to project.
{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", // IAM user name "password": "********", // IAM user password "domain": { "name": "domainname" // Name of the account to which the IAM user belongs } } } }, "scope": { "project": { "name": "xxxxxxxx" // Project Name } } } }
After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
1 2 3 |
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... |
AK/SK Authentication
AK/SK authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token authentication is recommended.
In AK/SK authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.
- AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
- SK: secret access key, which is used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
In AK/SK authentication, you can use an AK/SK to sign requests based on the signature algorithm or using the signing SDK. For details about how to sign requests and use the signing SDK, see API Request Signing Guide.
The signing SDK is only used for signing requests and is different from the SDKs provided by services.
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