API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (hbr/2017-09-08) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Backup vaults
|
API |
Title |
Description |
| CreateVault | CreateVault | Creates a backup vault. |
| DescribeVaults | DescribeVaults | Describes one or more backup vaults that meet specified criteria. |
Backup plans
|
API |
Title |
Description |
| CreateBackupPlan | CreateBackupPlan | Creates a backup plan. |
| DeleteBackupPlan | DeleteBackupPlan | Deletes a backup plan. |
| DisableBackupPlan | DisableBackupPlan | Disables a backup plan. |
| EnableBackupPlan | EnableBackupPlan | Resumes a backup plan. |
| UpdateBackupPlan | UpdateBackupPlan | Updates a backup plan. |
| DescribeBackupPlans | DescribeBackupPlans | Gets one or more backup plans that meet specified conditions. |
| ExecuteBackupPlan | ExecuteBackupPlan | Executes a backup plan. |
Backup policy
|
API |
Title |
Description |
| CreatePolicyV2 | CreatePolicyV2 | Creates a backup policy. |
| DeletePolicyV2 | DeletePolicyV2 | Deletes a policy. |
| DescribePoliciesV2 | DescribePoliciesV2 | Queries one or more policies. |
| DeletePolicyBinding | DeletePolicyBinding | Detaches a data source from a policy. After the data source is detached, the policy no longer protects it. Use this operation with caution. |
| UpdatePolicyBinding | UpdatePolicyBinding | Updates the association between a backup policy and a data source. |
| DescribePolicyBindings | List Bound Policies | You can query the data sources attached to a policy, or the policies attached to a data source. |
Backup clients
|
API |
Title |
Description |
| DeleteBackupClient | DeleteBackupClient | Deletes a Cloud Backup client. |
| DeleteBackupClientResource | DeleteBackupClientResource | Deletes the resources of a backup client. |
| DescribeBackupClients | DescribeBackupClients | Queries the information about one or more backup clients that meet specified conditions. |
| InstallBackupClients | InstallBackupClients | Installs backup clients on one or more ECS instances. |
Backup files
|
API |
Title |
Description |
| DeleteSnapshot | DeleteSnapshot | Deletes a backup snapshot. |
| SearchHistoricalSnapshots | SearchHistoricalSnapshots | Retrieves one or more historical backup snapshots that meet the specified criteria. |
| DescribeUdmSnapshots | DescribeUdmSnapshots | Queries the snapshots of full backups. |
Restore jobs
|
API |
Title |
Description |
| CreateRestoreJob | CreateRestoreJob | Creates a restore job. |
| CancelRestoreJob | CancelRestoreJob | Cancels a restore job. |
| DescribeRestoreJobs2 | DescribeRestoreJobs2 | Queries one or more restore jobs that meet specified conditions. |
Backup jobs
|
API |
Title |
Description |
| CancelBackupJob | CancelBackupJob | Cancels a backup job. |
| DescribeBackupJobs2 | DescribeBackupJobs2 | Queries backup jobs that meet the specified criteria. |
Backup of SAP HANA
|
API |
Title |
Description |
| DeleteClient | DeleteClient | Deletes a client. |
| DescribeHanaBackupPlans | DescribeHanaBackupPlans | Queries for one or more SAP HANA backup plans that match specified criteria. |
Container backup
|
API |
Title |
Description |
| DescribeContainerResource | DescribeContainerResource | Queries the list of container cluster resources. |
| DeleteContainerCluster | DeleteContainerCluster | Unregisters a container cluster record in Cloud Backup. After you unregister the cluster, you cannot recover backups of the cluster. |
Other
|
API |
Title |
Description |
| DescribeCrossAccounts | DescribeCrossAccounts | Queries information about cross-account management relationships. |
| AddCrossAccount | AddCrossAccount | Create a cross-account management relationship. |
| CreateVaultReplication | CreateVaultReplication | Configures backup vault replication. |
| DeleteCrossAccount | DeleteCrossAccount | Deletes a cross-account management relationship. |
| DeleteVaultReplication | DeleteVaultReplication | Stops backup vault replication. |
| ListProtectedResources | ListProtectedResources | Queries a list of protected resources. |
Others
|
API |
Title |
Description |
| AddContainerCluster | AddContainerCluster | Registers a Container Service for Kubernetes (ACK) cluster. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which an instance belongs. |
| CheckRole | CheckRole | Checks whether the user has permissions to access the current resource or page. |
| CreateBackupJob | CreateBackupJob | Creates a backup job. |
| CreateClients | CreateClients | Installs one or more Cloud Backup clients on specified instances. |
| CreateHanaBackupPlan | CreateHanaBackupPlan | Creates a backup plan for an SAP HANA instance. |
| CreateHanaInstance | CreateHanaInstance | Registers an SAP HANA instance. |
| CreateHanaRestore | CreateHanaRestore | Creates a restore job for an SAP HANA database. |
| CreatePolicyBindings | CreatePolicyBindings | Binds one or more data sources to a backup policy. |
| CreateReplicationVault | CreateReplicationVault | Creates a mirror vault. |
| CreateTempFileUploadUrl | CreateTempFileUploadUrl | Generates the parameters and signature required for a file upload URL. |
| DeleteAirEcsInstance | DeleteAirEcsInstance | Removes the Elastic Compute Service (ECS) instance that is used for restoration only in ECS Backup Essential Edition. |
| DeleteHanaBackupPlan | DeleteHanaBackupPlan | Deletes an SAP HANA backup plan. |
| DeleteHanaInstance | DeleteHanaInstance | Deletes an SAP HANA instance. |
| DeleteUdmDisk | DeleteUdmDisk | Cancels a protected disk. |
| DeleteUdmEcsInstance | DeleteUdmEcsInstance | Stops protection for Elastic Compute Service (ECS) instance backup. |
| DeleteVault | DeleteVault | Deletes a backup vault. |
| DescribeClients | DescribeClients | Queries one or more Cloud Backup clients that meet the specified conditions. |
| DescribeContainerCluster | DescribeContainerCluster | Queries one or more container clusters that meet the specified conditions. |
| DescribeHanaBackupSetting | DescribeHanaBackupSetting | Queries the backup parameters of an SAP HANA database. |
| DescribeHanaBackupsAsync | DescribeHanaBackupsAsync | Queries one or more SAP HANA backups that meet the specified conditions. |
| DescribeHanaDatabases | DescribeHanaDatabases | Queries the information about SAP HANA databases. |
| DescribeHanaInstances | DescribeHanaInstances | Queries one or more SAP HANA instances that meet the specified conditions. |
| DescribeHanaRestores | DescribeHanaRestores | Queries one or more SAP HANA restore jobs that meet the specified conditions. |
| DescribeHanaRetentionSetting | DescribeHanaRetentionSetting | Queries the backup retention period of an SAP HANA database. |
| DescribeOtsTableSnapshots | DescribeOtsTableSnapshots | Queries the details about Tablestore instances that are backed up. |
| DescribeRecoverableOtsInstances | DescribeRecoverableOtsInstances | Queries the tables of a restorable Tablestore instance. |
| DescribeRegions | DescribeRegions | Queries available regions. |
| DescribeTask | DescribeTask | Queries an asynchronous job. |
| DescribeVaultReplicationRegions | DescribeVaultReplicationRegions | Queries the regions that support cross-region replication. |
| DetachNasFileSystem | DetachNasFileSystem | Deletes an internal mount target created by Cloud Backup. |
| DisableHanaBackupPlan | DisableHanaBackupPlan | Disables an SAP HANA backup plan. |
| EnableHanaBackupPlan | EnableHanaBackupPlan | Enables an SAP HANA backup plan. |
| ExecutePolicyV2 | Execute Policy | Execute a policy for one or all bound data sources. |
| GenerateRamPolicy | GenerateRamPolicy | Generates a Resource Access Management (RAM) policy. |
| GetTempFileDownloadLink | GetTempFileDownloadLink | Obtains download links of files such as job reports. |
| OpenHbrService | OpenHbrService | Activates Cloud Backup. |
| StartHanaDatabaseAsync | StartHanaDatabaseAsync | Starts an SAP HANA database. |
| StopHanaDatabaseAsync | StopHanaDatabaseAsync | Stops an SAP HANA database. |
| UninstallBackupClients | UninstallBackupClients | Uninstalls a Cloud Backup client from one or more Elastic Compute Service (ECS) instance. |
| UninstallClient | UninstallClient | Uninstalls an HBR client. |
| UpdateClientSettings | UpdateClientSettings | Updates the configurations of an HBR client. |
| UpdateContainerCluster | Update Container Cluster Information | Update container cluster information, including the container cluster name, network type, etc. |
| UpdateHanaBackupPlan | UpdateHanaBackupPlan | Updates an SAP HANA backup plan. |
| UpdateHanaBackupSetting | UpdateHanaBackupSetting | Updates the backup parameters of an SAP HANA database. |
| UpdateHanaInstance | UpdateHanaInstance | Updates an SAP HANA instance. |
| UpdateHanaRetentionSetting | UpdateHanaRetentionSetting | Updates the backup retention period of an SAP HANA database. |
| UpdatePolicyV2 | UpdatePolicyV2 | Modifies a backup policy. |
| UpdateVault | UpdateVault | Updates the configuration information about the backup vault. |
| UpgradeBackupClients | UpgradeBackupClients | Upgrades an HBR client on one or more Elastic Compute Service (ECS) instances. |
| UpgradeClient | UpgradeClient | Upgrades the Cloud Backup client. |