API standards and multilingual preset SDKs
The OpenAPI of this product (hbr/2017-09-08) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Backup vault
|
API |
Title |
Description |
| CreateVault | CreateVault | Creates a backup vault. |
| DescribeVaults | DescribeVaults | Describes one or more backup vaults that meet specified criteria. |
Backup plan
|
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 | Create a policy. |
| DeletePolicyV2 | DeletePolicyV2 | Deletes a policy. |
| UpdatePolicyV2 | UpdatePolicyV2 | Modifies a backup policy. |
| DescribePoliciesV2 | DescribePoliciesV2 | Queries one or more policies. |
| CreatePolicyBindings | CreatePolicyBindings | Binds one or more data sources to a backup policy. |
| 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 client
|
API |
Title |
Description |
| DeleteBackupClient | DeleteBackupClient | Deletes a Cloud Backup client. |
| DeleteBackupClientResource | DeleteBackupClientResource | Deletes the resources of a backup client. |
| UpdateClientSettings | UpdateClientSettings | Updates the settings of a Cloud 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 snapshot
|
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 job
|
API |
Title |
Description |
| CreateRestoreJob | CreateRestoreJob | Creates a restore job. |
| CancelRestoreJob | CancelRestoreJob | Cancels a restore job. |
| DescribeRestoreJobs2 | DescribeRestoreJobs2 | Queries restore jobs that match specified criteria. |
Backup job
|
API |
Title |
Description |
| CancelBackupJob | CancelBackupJob | Cancels a backup job. |
| DescribeBackupJobs2 | DescribeBackupJobs2 | Queries backup jobs that meet the specified criteria. |
SAP HANA backup
|
API |
Title |
Description |
| DeleteClient | DeleteClient | Deletes a client. |
| UpgradeClient | UpgradeClient | Upgrades the Cloud Backup client. |
| DescribeHanaBackupPlans | DescribeHanaBackupPlans | Queries for one or more SAP HANA backup plans that match specified criteria. |
ECS backup essential edition
|
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. |
| DescribeContainerCluster | DescribeContainerCluster | Queries one or more container clusters that meet the specified conditions. |
Container backup
|
API |
Title |
Description |
| OpenHbrService | OpenHbrService | Activates Cloud Backup. |
| DetachNasFileSystem | DetachNasFileSystem | Deletes an internal mount target created by Cloud Backup. |
| DescribeCrossAccounts | DescribeCrossAccounts | Queries cross-account management relationships. |
| AddCrossAccount | AddCrossAccount | Create a cross-account management relationship. |
| AddDataSource | AddDataSource | Creates a data source. |
| BrowseFiles | BrowseFiles | Browses the list of backup files in a specified backup snapshot. |
| CreateVaultReplication | CreateVaultReplication | Configures backup vault replication. |
| DeleteCrossAccount | DeleteCrossAccount | Deletes a cross-account management relationship. |
| DeleteVaultReplication | DeleteVaultReplication | Stops backup vault replication. |
| DescribeDataSources | DescribeDataSources | Queries a list of data sources. Filter results by data source type, data source ID, data source name, or client group ID. |
| GetBasicStatistics | GetBasicStatistics | Retrieves basic statistics for Backup. |
| ListProtectedResources | ListProtectedResources | Queries protected resources |
| RemoveDataSource | RemoveDataSource | Deletes a data source. |
| UpdateDataSource | UpdateDataSource | Updates the data source configuration. |
| AddContainerCluster | AddContainerCluster | Registers a Container Service for Kubernetes (ACK) cluster. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which an instance belongs. |
| CheckRole | Check permissions | Checks whether the current user has permissions to access a specific 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |