This product(
hbr/2017-09-08) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Backup vaults
| API | Title | Description |
|---|---|---|
| CreateVault | CreateVault | Creates a backup vault. |
| CreateReplicationVault | CreateReplicationVault | Creates a mirror vault. |
| DeleteVault | DeleteVault | Deletes a backup vault. |
| UpdateVault | UpdateVault | Updates the configuration information about the backup vault. |
| DescribeVaults | DescribeVaults | Queries the information about one or more backup vaults that meet the specified conditions. |
Backup plans
| API | Title | Description |
|---|---|---|
| CreateBackupPlan | Create a Backup Plan | Create a backup plan. |
| DeleteBackupPlan | DeleteBackupPlan | Deletes a backup plan. |
| DisableBackupPlan | DisableBackupPlan | Disables a backup plan. |
| EnableBackupPlan | EnableBackupPlan | Enables a backup plan. |
| UpdateBackupPlan | UpdateBackupPlan | Updates a backup plan. |
| DescribeBackupPlans | DescribeBackupPlans | Queries the information about one or more backup plans that meet the specified conditions. |
| ExecuteBackupPlan | ExecuteBackupPlan | Executes a backup plan. |
Backup policies
| API | Title | Description |
|---|---|---|
| CreatePolicyV2 | CreatePolicyV2 | Creates a backup policy. |
| DeletePolicyV2 | DeletePolicyV2 | Deletes a backup policy. |
| UpdatePolicyV2 | UpdatePolicyV2 | Modifies a backup policy. |
| DescribePoliciesV2 | DescribePoliciesV2 | Queries one or more backup policies. |
| CreatePolicyBindings | CreatePolicyBindings | Binds one or more data sources to a backup policy. |
| DeletePolicyBinding | DeletePolicyBinding | Disassociates one or more data sources from a backup policy. After you disassociate the data sources from the backup policy, the backup policy no longer protects the data sources. Proceed with caution. |
| UpdatePolicyBinding | UpdatePolicyBinding | Modifies the association between a backup policy and a data source. |
| DescribePolicyBindings | List Bound Policies | Query one or more data sources bound to a policy, or query one or more policies bound to a data source. |
| ExecutePolicyV2 | Execute Policy | Execute a policy for one or all bound data sources. |
Backup clients
| API | Title | Description |
|---|---|---|
| DeleteBackupClient | DeleteBackupClient | Deletes a Cloud Backup client. |
| DeleteBackupClientResource | DeleteBackupClientResource | Deletes the resources that are related to one or more HBR clients. |
| UpdateClientSettings | UpdateClientSettings | Updates the configurations of an HBR client. |
| DescribeBackupClients | DescribeBackupClients | Queries the information about one or more HBR clients that meet the specified conditions. |
| InstallBackupClients | InstallBackupClients | Installs an HBR client on one or more Elastic Compute Service (ECS) instances. |
| UninstallBackupClients | UninstallBackupClients | Uninstalls a Cloud Backup client from one or more Elastic Compute Service (ECS) instance. |
| UpgradeBackupClients | UpgradeBackupClients | Upgrades an HBR client on one or more Elastic Compute Service (ECS) instances. |
Backup files
| API | Title | Description |
|---|---|---|
| DeleteSnapshot | DeleteSnapshot | Deletes a backup snapshot. |
| DescribeOtsTableSnapshots | DescribeOtsTableSnapshots | Queries the details about Tablestore instances that are backed up. |
| DescribeRecoverableOtsInstances | DescribeRecoverableOtsInstances | Queries the tables of a restorable Tablestore instance. |
| SearchHistoricalSnapshots | SearchHistoricalSnapshots | Queries the information about one or more backup snapshots that meet the specified conditions. |
| DescribeUdmSnapshots | DescribeUdmSnapshots | Queries the backup snapshots of an Elastic Compute Service (ECS) instance. |
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 the specified conditions. |
Backup jobs
| API | Title | Description |
|---|---|---|
| CreateBackupJob | CreateBackupJob | Creates a backup job. |
| CancelBackupJob | CancelBackupJob | Cancels a backup job. |
| DescribeBackupJobs2 | DescribeBackupJobs2 | Queries the information about one or more backup jobs that meet the specified conditions. |
Backup of SAP HANA
| API | Title | Description |
|---|---|---|
| CreateHanaBackupPlan | CreateHanaBackupPlan | Creates a backup plan for an SAP HANA instance. |
| CreateHanaInstance | CreateHanaInstance | Registers an SAP HANA instance. |
| CreateClients | CreateClients | Installs one or more Cloud Backup clients on specified instances. |
| CreateHanaRestore | CreateHanaRestore | Creates a restore job for an SAP HANA database. |
| DeleteHanaBackupPlan | DeleteHanaBackupPlan | Deletes an SAP HANA backup plan. |
| DeleteHanaInstance | DeleteHanaInstance | Deletes an SAP HANA instance. |
| UninstallClient | UninstallClient | Uninstalls an HBR client. |
| UpdateHanaBackupPlan | UpdateHanaBackupPlan | Updates an SAP HANA backup plan. |
| EnableHanaBackupPlan | EnableHanaBackupPlan | Enables an SAP HANA backup plan. |
| DisableHanaBackupPlan | DisableHanaBackupPlan | Disables an SAP HANA backup plan. |
| UpdateHanaInstance | UpdateHanaInstance | Updates an SAP HANA instance. |
| UpgradeClient | UpgradeClient | Upgrades the Cloud Backup client. |
| StartHanaDatabaseAsync | StartHanaDatabaseAsync | Starts an SAP HANA database. |
| StopHanaDatabaseAsync | StopHanaDatabaseAsync | Stops an SAP HANA database. |
| UpdateHanaRetentionSetting | UpdateHanaRetentionSetting | Updates the backup retention period of an SAP HANA database. |
| UpdateHanaBackupSetting | UpdateHanaBackupSetting | Updates the backup parameters of an SAP HANA database. |
| DescribeHanaBackupPlans | DescribeHanaBackupPlans | Queries one or more SAP HANA backup plans that meet the specified conditions. |
| DescribeHanaInstances | DescribeHanaInstances | Queries one or more SAP HANA instances that meet the specified conditions. |
| DescribeClients | DescribeClients | Queries one or more Cloud Backup clients that meet the specified conditions. |
| DescribeHanaDatabases | DescribeHanaDatabases | Queries the information about SAP HANA databases. |
| DescribeHanaRetentionSetting | DescribeHanaRetentionSetting | Queries the backup retention period of an SAP HANA database. |
| 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. |
| DescribeHanaRestores | DescribeHanaRestores | Queries one or more SAP HANA restore jobs that meet the specified conditions. |
Others
| API | Title | Description |
|---|---|---|
| OpenHbrService | OpenHbrService | Activates Cloud Backup. |
| AddContainerCluster | AddContainerCluster | Registers a Container Service for Kubernetes (ACK) cluster. |
| DescribeRegions | DescribeRegions | Queries available regions. |
| DescribeTask | DescribeTask | Queries an asynchronous job. |
| DescribeVaultReplicationRegions | DescribeVaultReplicationRegions | Queries the regions that support cross-region replication. |
| DescribeContainerCluster | DescribeContainerCluster | Queries one or more container clusters that meet the specified conditions. |
| DetachNasFileSystem | DetachNasFileSystem | Deletes an internal mount target created by Cloud Backup. |
| GenerateRamPolicy | GenerateRamPolicy | Generates a Resource Access Management (RAM) policy. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which an instance belongs. |
| CreateTempFileUploadUrl | CreateTempFileUploadUrl | Generates the parameters and signature required for a file upload URL. |
| GetTempFileDownloadLink | GetTempFileDownloadLink | Obtains download links of files such as job reports. |
| CheckRole | CheckRole | Checks whether the user has permissions to access the current resource or page. |
| DescribeCrossAccounts | DescribeCrossAccounts | Queries the information about the accounts used in cross-account backup. |
| DescribeCrossAccounts | DescribeCrossAccounts | |
| DeleteUdmEcsInstance | DeleteUdmEcsInstance | Stops protection for Elastic Compute Service (ECS) instance backup. |
| DeleteUdmDisk | DeleteUdmDisk | Cancels a protected disk. |