- What's New
- Service Overview
- Getting Started
- User Guide
-
Best Practices
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Change History
- API Reference
-
FAQs
-
About Concepts
- What Is CSBS?
- What Are Full Backup and Incremental Backup?
- What Is Consistent Backup?
- What Are the Differences Between CSBS and VBS?
- What Is a Backup Policy?
- What Are the Differences Between Backup and Disaster Recovery?
- What Are the Differences Between Backup and Snapshot?
- Why Is the Disk Space Usage Displayed in the File System Different from the Backup Size?
-
About Pricing
- How Is CSBS Billed?
- How Do Yearly/Monthly Resource Packages Function When I Have Bought More Than One?
- Are CSBS and VBS Resource Packages Interoperable Between CSBS and VBS?
- Why Am I Charged in Pay-per-use Mode Although I Have Purchased Resource Package?
- What Exactly Are the Function Package and the Storage Package?
- Will the CSBS Backups Displayed on the VBS Page Be Charged Repeatedly?
- How Do I Query CSBS Pay-Per-Use Billing Details?
- Why Is the Fee Deducted After a Backup Is Deleted?
- How Do I Disable CSBS?
- How Do I Stop CSBS from Charging?
-
About Backup
- Does CSBS Support Backing Up All EVS Disks on an ECS?
- Do I Need to Stop the ECS Before Backing It Up?
- Can an ECS with Application Systems Be Backed Up?
- What Are the Minimum Backup Frequency and Maximum Number of Retained Backups Supported by CSBS?
- How Can I Distinguish Automatic Backups From Manual Backups?
- How Can I Configure a Backup Policy?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CSBS Support Cross-Region Backup for ECSs?
- Which Types of Databases Can Be Backed Up Using Database Server Backup?
- How Do I Select Among Database Server Backup, Cloud Server Backup, and Disk Backup?
- How Do I Migrate ECS Data Across Regions Using CSBS?
- Which Time Zone Is the Automatic Backup Time Based On?
- What Can I Do If a Backup Cannot Be Deleted?
- About Restoration
- Others
-
About Concepts
- Troubleshooting
- Videos
- Glossary
-
More Documents
-
User Guide (Paris and Amsterdam Regions)
- Service Overview
- Getting Started
- Management Operations
-
FAQs
- About Concepts
-
About Backup
- Does CSBS Support Backing Up All EVS Disks on an ECS?
- Do I Need to Stop the ECS Before Backing It Up?
- Can an ECS with Application Systems Be Backed Up?
- What Are the Minimum Backup Frequency and Maximum Number of Retained Backups Supported by CSBS?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Does CSBS Support Cross-Region Backup for ECSs?
- About Restoration
- Others
- Troubleshooting Cases
- Change History
- API Reference (Paris and Amsterdam Regions)
-
User Guide (Paris and Amsterdam Regions)
- General Reference
Copied.
Querying Backup Capabilities of Resources
Function
This API is used to query whether resources can be backed up.
URI
- URI format
POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action
- Parameter description
Table 1 Parameter description Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID
For details about how to obtain the project ID, see Obtaining a Project ID.
provider_id
Yes
String
Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.
Request
- Parameter description
Table 2 Parameter description Parameter
Mandatory
Type
Description
check_protectable
Yes
List<protectable_param>
Query parameter list
For details, see Table 3.
- Parameter description of field protectable_param
Table 3 Parameter description of field protectable_param Parameter
Mandatory
Type
Description
resource_id
Yes
String
ID of the resource (server, or EVS disk) to be checked
For details about how to obtain the server ID, see the Elastic Cloud Server API Reference. For details about how to obtain the disk ID, see the Elastic Volume Service API Reference.
resource_type
Yes
String
Type of the resource to be checked, for example, OS::Nova::Server for an ECS
- Example request
POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action { "check_protectable" : [ { "resource_id" : "6507cb66-90dc-4a12-a573-c9f3398f899d", "resource_type" : "OS::Nova::Server" } ] }
Response
- Parameter description
Table 4 Parameter description Parameter
Type
Description
protectable
List<check_resp>
Check result list
For details, see Table 5.
- Parameter description of field check_resp
Table 5 Parameter description of field check_resp Parameter
Type
Description
result
Boolean
Whether backup or restoration is supported
true: yes
false: no
resource_type
String
Resource type
Possible values are OS::Nova::Server (ECS) and OS::Ironic::BareMetalServer (BMS).
error_code
String
Error code. If an error occurs, a value is returned.
error_msg
String
Error message, which will be returned if the VM is associated with a backup policy. If an error occurs, a value is returned.
resource_id
String
Resource ID
- Example response
{ "protectable" : [ { "resource_id" : "6507cb66-90dc-4a12-a573-c9f3398f899d", "resource_type" : "OS::Nova::Server", "result" : true } ] }
Status Codes
- Normal
Status Code
Description
200
OK
- Abnormal
Status Code
Description
400
Invalid request parameters.
401
Authentication failed.
403
No operation permission.
404
Requested object not found.
500
Service internal error.
503
Service unavailable.
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