Use API online debugging, Alibaba Cloud SDKs, Terraform, Resource Orchestration Service, and other calling methods - Cloud Backup

Cloud Backup provides a visual console and multiple integration methods, including API online debugging, Alibaba Cloud SDKs, and Resource Orchestration Service (ROS). Select an integration method based on your business requirements.

API overview

Alibaba Cloud provides OpenAPI Explorer to help you understand and use API operations of Alibaba Cloud services. OpenAPI Explorer integrates intelligent search, documentation, online debugging, SDK sample code, error diagnostics, and call statistics. You can call API operations, view requests and responses, and obtain auto-generated SDK sample code. For more information, see What is OpenAPI?

Version description

Alibaba Cloud OpenAPI Explorer manages API versions by version number. Cloud Backup supports the 2017-09-08 version, which is an API version identifier rather than a date. 2017-09-08 is the latest version of the Cloud Backup API.

API version	Description
2017-09-08	Recommended

Online debugging

Cloud Backup supports API debugging in OpenAPI Explorer. Before you call API operations, familiarize yourself with the available versions, endpoints, and integration methods.

Debugging page

The URL of the API debugging page is https://next.api.alibabacloud.com/api/hbr/2017-09-08/CreateVault?sdkStyle=old.

Endpoints

Select an endpoint based on the region where your resource resides. For example, in the China (Zhangjiakou) region, the public endpoint of Cloud Backup is hbr.cn-zhangjiakou.aliyuncs.com and the VPC endpoint is hbr-vpc.cn-zhangjiakou.aliyuncs.com.

Public endpoints can be accessed globally.
VPC endpoints are accessible only from within a VPC in the corresponding region. They provide the following advantages:
- High security: accessible only from within a VPC, which provides stronger security and privacy.
- Fast response: internal network routing delivers lower latency and avoids public network bandwidth limitations.
- Low cost: traffic over internal networks incurs no public bandwidth charges.

For more information, see Endpoints.

User identities

By default, OpenAPI Explorer uses your Alibaba Cloud account for online debugging. Because an Alibaba Cloud account has full API permissions, we recommend that you use a Resource Access Management (RAM) user for API calls and routine O&M. Grant the RAM user only the permissions required to manage Cloud Backup resources. For more information, see Create a RAM user to perform Cloud Backup operations.

Identity	Supported or not
Alibaba Cloud account	Yes
RAM user (recommended)	Yes
RAM role (recommended)	Yes

References

Integration methods

Note

SDKs integrate easily with applications and cover the widest range of operations. We recommend that you use SDKs to call API operations.

Overview of integration methods

Calling method	Supported or not
Alibaba Cloud SDKs (recommended)	Yes
Alibaba Cloud CLI	No
ROS	No
Custom API encapsulation	Yes

Alibaba Cloud SDKs
- Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, Node.js, TypeScript, PHP, and C++. SDKs encapsulate data signing, timeout handling, and retry logic, and return structured response objects. For more information, see Alibaba Cloud SDKs.
- You can use Alibaba Cloud SDKs to call the API operations of Cloud Backup. For more information about supported languages and dependencies, go to OpenAPI Portal.
Alibaba Cloud CLI
- You can run aliyun commands to interact with Alibaba Cloud services and manage cloud resources. For more information, see What is Alibaba Cloud CLI
- You cannot use Alibaba Cloud command-line interface (CLI) to call the API operations of Cloud Backup.
ROS
- ROS is an Alibaba Cloud service that simplifies cloud resource management. You can create templates to describe the required resources, such as Elastic Compute Service (ECS) instances, Object Storage Service (OSS) buckets, and File Storage NAS (NAS) file systems, along with their dependencies. ROS automatically creates and configures all resources based on templates for automated deployment and O&M. For more information, see What is Resource Orchestration Service
- You can use ROS to call the API operations of Cloud Backup. Resources that can be orchestrated by using ROS include regular resources (such as backup clients, restore jobs, and backup plans) and data resources (such as backup vaults).
  - Regular resources:
    - ALIYUN::HBR::BackupClients: installs backup clients on ECS instances.
    - ALIYUN::HBR::RestoreJob: creates a restore job.
    - ALIYUN::HBR::DbAgent: installs a backup client for a database.
    - ALIYUN::HBR::DbPlan: creates a backup plan.
    - ALIYUN::HBR::DbVault: creates a mirror vault.
    - ALIYUN::HBR::Vault: creates a backup vault.
  - Data resources:
    - DATASOURCE::HBR::Vaults: queries the information about backup vaults.
- For more information about how to use ROS to orchestrate Cloud Backup resources with efficiency, see Example of integration with ROS.
Custom API encapsulation

To make native HTTP calls, you must construct custom requests and sign the requests. For information about the signature method, see API overview and Request syntax and signature method V3.

Precautions

If an API operation returns an error, verify your request parameters against the error code. For more information, see Public error codes.

You can also perform self-service diagnostics based on the returned request ID or SDK error information on the OpenAPI Diagnosis page.

FAQ

For more information about Cloud Backup, see What is Cloud Backup
Cloud Backup supports backing up ECS instances, ECS-hosted MySQL, SQL Server, and Oracle databases, ECS files, NAS file systems, and OSS buckets. You can also back up files, databases, virtual machines, and large-scale file systems from self-managed data centers, and implement disaster recovery. For more information, see Features.
Cloud Backup provides SDKs in multiple programming languages, including Java, C#, Go, Python, Node.js, TypeScript, PHP, and C++. For more information, see SDK references.