Docs

Cloud Backup and Recovery

Usage method

Request structure

This document introduces the API request structure for cloud backup CBR.

Service endpoint

The available regions for cloud backup CBR are listed in the table below.

Enable region	RegionId	Service access address
China (Beijing)	cn-beijing	cbr.cn-beijing.volcengineapi.com
China (Guangzhou)	cn-guangzhou	cbr.cn-guangzhou.volcengineapi.com
China (Shanghai)	cn-shanghai	cbr.cn-shanghai.volcengineapi.com

Communication protocol

All interfaces use the HTTPS protocol for requests, providing a secure communication channel.

Request URL

You can call the CBR API service by sending an HTTPS POST request. The format for the HTTPS request URL is as follows:

Where:

URI-scheme: Indicates the protocol used to transmit requests. All APIs currently use the HTTPS protocol.

Action: Operation to perform. Enter the API you want to call here. For the Cloud Backup CBR API, see API Overview.

Version: API version number in the YYYY-MM-DD format. The API version for Cloud Backup CBR is 2024-03-01.

For example, when creating a backup task in the Beijing region, the unencoded HTTPS request URL is as follows.

Request Parameters

Each API request contains the following two types of parameters:

Public request parameters: Parameters required for every API are considered public request parameters. For more information about public parameters, see Public Parameters.

API request parameters: Each API has unique parameters used for requests. For details on the request parameters for each API, refer to the interface descriptions in API Overview.

Character encoding

All use UTF-8 encoding.

Last updated: 2026.09.10 16:27:14