All Products
Search
Document Center

Hybrid Backup Recovery:List of operations by function

Last Updated:Sep 28, 2022
This product(hbr/2017-09-08) OpenAPI adopts RPC Signature style, see signature details 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 service nail group (11370001915) 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

APItitleDescription
CreateVaultCreateVaultCreates a backup vault.
CreateReplicationVaultCreateReplicationVaultCreates a replication backup vault.
DeleteVaultDeleteVaultDeletes a backup vault.
UpdateVaultUpdateVaultUpdates the settings of a backup vault.
DescribeVaultsDescribeVaultsQueries the information about one or more backup vaults that meet the specified conditions.

Backup plans

APItitleDescription
CreateBackupPlanCreateBackupPlanCreates a backup plan.
DeleteBackupPlanDeleteBackupPlanDeletes a backup plan.
DisableBackupPlanDisableBackupPlanDisables a backup plan.
EnableBackupPlanEnableBackupPlanEnables a backup plan.
UpdateBackupPlanUpdateBackupPlanUpdates a backup plan.
DescribeBackupPlansDescribeBackupPlansQueries one or more backup plans that meet the specified conditions.
ExecuteBackupPlanExecuteBackupPlanExecutes a backup plan.

Backup clients

APItitleDescription
DeleteBackupClientDeleteBackupClientDeletes a backup client.
DeleteBackupClientResourceDeleteBackupClientResourceDeletes the resources that are related to backup clients.
UpdateClientSettingsUpdateClientSettingsUpdates the settings of a backup client.
DescribeBackupClientsDescribeBackupClientsQueries the information about one or more backup clients that meet the specified conditions.
InstallBackupClientsInstallBackupClientsInstalls a backup client on one or more Elastic Compute Service (ECS) instances.
UninstallBackupClientsUninstallBackupClientsUninstalls a backup client from one or more Elastic Compute Service (ECS) instances.
UpgradeBackupClientsUpgradeBackupClientsUpgrades a backup client that is installed on one or more ECS instances.

Backup files

APItitleDescription
DeleteSnapshotDeleteSnapshotDeletes a backup file.
DescribeOtsTableSnapshotsDescribeOtsTableSnapshotsQueries the details about Tablestore instances that are backed up.
DescribeRecoverableOtsInstancesDescribeRecoverableOtsInstancesQueries the Tablestore instances that can be restored and the tables in the instances.
SearchHistoricalSnapshotsSearchHistoricalSnapshotsQueries one or more historical backup snapshots that meet the specified conditions.

Restore jobs

APItitleDescription
CreateRestoreJobCreateRestoreJobCreates a restore job.
CancelRestoreJobCancelRestoreJobCancels a restore job.
DescribeRestoreJobs2DescribeRestoreJobs2Queries one or more restore jobs that meet the specified conditions.

Backup jobs

APItitleDescription
CreateBackupJobCreateBackupJobCreate a backup job.
CancelBackupJobCancelBackupJobCancels a backup job.
DescribeBackupJobs2DescribeBackupJobs2Queries one or more backup jobs that meet the specified conditions.

Backup of SAP HANA

APItitleDescription
CreateHanaBackupPlanCreateHanaBackupPlanCreates an SAP HANA backup plan.
CreateHanaInstanceCreateHanaInstanceRegisters an SAP HANA instance.
CreateClientsCreateClientsInstalls one or more HBR backup clients on specified instances.
CreateHanaRestoreCreateHanaRestoreCreates a restore job for an SAP HANA database.
DeleteHanaBackupPlanDeleteHanaBackupPlanDeletes an SAP HANA backup plan.
DeleteHanaInstanceDeleteHanaInstanceDeletes an SAP HANA instance.
UninstallClientUninstallClientUninstalls an HBR backup client.
UpdateHanaBackupPlanUpdateHanaBackupPlanUpdates the settings of an SAP HANA backup plan.
EnableHanaBackupPlanEnableHanaBackupPlanEnables an SAP HANA backup plan.
DisableHanaBackupPlanDisableHanaBackupPlanDisables an SAP HANA backup plan.
UpdateHanaInstanceUpdateHanaInstanceUpdates an SAP HANA instance.
UpgradeClientUpgradeClientUpgrades an HBR backup client.
StartHanaDatabaseAsyncStartHanaDatabaseAsyncStarts an SAP HANA database.
StopHanaDatabaseAsyncStopHanaDatabaseAsyncStops an SAP HANA database.
UpdateHanaRetentionSettingUpdateHanaRetentionSettingUpdates the backup retention period of an SAP HANA database.
UpdateHanaBackupSettingUpdateHanaBackupSettingUpdates the backup parameters of an SAP HANA database.
DescribeHanaBackupPlansDescribeHanaBackupPlansQueries one or more SAP HANA backup plans that meet the specified conditions.
DescribeHanaInstancesDescribeHanaInstancesQueries one or more SAP HANA instances that meet the specified conditions.
DescribeClientsDescribeClientsQueries the information about one or more backup clients that meet the specified conditions.
DescribeHanaDatabasesDescribeHanaDatabasesQueries the information about SAP HANA databases.
DescribeHanaRetentionSettingDescribeHanaRetentionSettingQueries the backup retention period of an SAP HANA database.
DescribeHanaBackupSettingDescribeHanaBackupSettingQueries the backup parameters of an SAP HANA database.
DescribeHanaBackupsAsyncDescribeHanaBackupsAsyncQueries one or more SAP HANA backups that meet the specified conditions.
DescribeHanaRestoresDescribeHanaRestoresQueries one or more SAP HANA restore jobs that meet the specified conditions.

Others

APItitleDescription
OpenHbrServiceOpenHbrService
AddContainerClusterAddContainerClusterRegister a container cluster.
DescribeRegionsDescribeRegionsQueries available regions.
DescribeTaskDescribeTaskQueries an asynchronous job.
DescribeVaultReplicationRegionsDescribeVaultReplicationRegionsQueries the regions that support cross-region replication.
DescribeUdmSnapshotsDescribeUdmSnapshotsQueries the backup snapshots of an Elastic Compute Service (ECS) instance.
DescribeContainerClusterDescribeContainerClusterQueries one or more container cluster that meet the specified conditions.
DetachNasFileSystemDetachNasFileSystemDeletes a mount target that is created by Hybrid Backup Recovery (HBR).
GenerateRamPolicyGenerateRamPolicyGenerates a RAM policy.
ChangeResourceGroupChangeResourceGroupChanges the resource group to which a specified resource belongs.
CreateTempFileUploadUrlCreateTempFileUploadUrl
GetTempFileDownloadLinkGetTempFileDownloadLink