All Products
Search
Document Center

Cloud Backup:List of operations by function

Last Updated:Nov 06, 2024
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

APITitleDescription
CreateVaultCreateVaultCreates a backup vault.
CreateReplicationVaultCreateReplicationVaultCreates a mirror vault.
DeleteVaultDeleteVaultDeletes a backup vault.
UpdateVaultUpdateVaultUpdates the configuration information about the 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 the information about one or more backup plans that meet the specified conditions.
ExecuteBackupPlanExecuteBackupPlanExecutes a backup plan.

Backup policies

APITitleDescription
CreatePolicyV2CreatePolicyV2Creates a backup policy.
DeletePolicyV2DeletePolicyV2Deletes a backup policy.
UpdatePolicyV2UpdatePolicyV2Modifies a backup policy.
DescribePoliciesV2DescribePoliciesV2Queries one or more backup policies.
CreatePolicyBindingsCreatePolicyBindingsBinds one or more data sources to a backup policy.
DeletePolicyBindingDeletePolicyBindingDisassociates 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.
UpdatePolicyBindingUpdatePolicyBindingModifies the association between a backup policy and a data source.
DescribePolicyBindingsDescribePolicyBindingsQueries one or more data sources bound to a backup policy or queries one or more backup policies bound to a data source.
ExecutePolicyV2ExecutePolicyV2Executes a backup policy for one or all data sources.

Backup clients

APITitleDescription
DeleteBackupClientDeleteBackupClientDeletes a Cloud Backup client.
DeleteBackupClientResourceDeleteBackupClientResourceDeletes the resources that are related to one or more HBR clients.
UpdateClientSettingsUpdateClientSettingsUpdates the configurations of an HBR client.
DescribeBackupClientsDescribeBackupClientsQueries the information about one or more HBR clients that meet the specified conditions.
InstallBackupClientsInstallBackupClientsInstalls an HBR client on one or more Elastic Compute Service (ECS) instances.
UninstallBackupClientsUninstallBackupClientsUninstalls a Cloud Backup client from one or more Elastic Compute Service (ECS) instance.
UpgradeBackupClientsUpgradeBackupClientsUpgrades an HBR client on one or more Elastic Compute Service (ECS) instances.

Backup files

APITitleDescription
DeleteSnapshotDeleteSnapshotDeletes a backup snapshot.
DescribeOtsTableSnapshotsDescribeOtsTableSnapshotsQueries the details about Tablestore instances that are backed up.
DescribeRecoverableOtsInstancesDescribeRecoverableOtsInstancesQueries the tables of a restorable Tablestore instance.
SearchHistoricalSnapshotsSearchHistoricalSnapshotsQueries the information about one or more backup snapshots that meet the specified conditions.
DescribeUdmSnapshotsDescribeUdmSnapshotsQueries the backup snapshots of an Elastic Compute Service (ECS) instance.

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
CreateBackupJobCreateBackupJobCreates a backup job.
CancelBackupJobCancelBackupJobCancels a backup job.
DescribeBackupJobs2DescribeBackupJobs2Queries the information about one or more backup jobs that meet the specified conditions.

Backup of SAP HANA

APITitleDescription
CreateHanaBackupPlanCreateHanaBackupPlanCreates a backup plan for an SAP HANA instance.
CreateHanaInstanceCreateHanaInstanceRegisters an SAP HANA instance.
CreateClientsCreateClientsInstalls one or more HBR 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 client.
UpdateHanaBackupPlanUpdateHanaBackupPlanUpdates an SAP HANA backup plan.
EnableHanaBackupPlanEnableHanaBackupPlanEnables an SAP HANA backup plan.
DisableHanaBackupPlanDisableHanaBackupPlanDisables an SAP HANA backup plan.
UpdateHanaInstanceUpdateHanaInstanceUpdates an SAP HANA instance.
UpgradeClientUpgradeClientUpgrades the Cloud 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 one or more Cloud 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
OpenHbrServiceOpenHbrServiceActivates Cloud Backup.
AddContainerClusterAddContainerClusterRegisters a Container Service for Kubernetes (ACK) cluster.
DescribeRegionsDescribeRegionsQueries available regions.
DescribeTaskDescribeTaskQueries an asynchronous job.
DescribeVaultReplicationRegionsDescribeVaultReplicationRegionsQueries the regions that support cross-region replication.
DescribeContainerClusterDescribeContainerClusterQueries one or more container clusters that meet the specified conditions.
DetachNasFileSystemDetachNasFileSystemDeletes a mount target that is created by Hybrid Backup Recovery (HBR).
GenerateRamPolicyGenerateRamPolicyGenerates a Resource Access Management (RAM) policy.
ChangeResourceGroupChangeResourceGroupChanges the resource group to which an instance belongs.
CreateTempFileUploadUrlCreateTempFileUploadUrlGenerates the parameters and signature required for a file upload URL.
GetTempFileDownloadLinkGetTempFileDownloadLinkObtains download links of files such as job reports.
CheckRoleCheckRoleChecks whether the user has permissions to access the current resource or page.
DescribeCrossAccountsDescribeCrossAccountsQueries the information about the accounts used in cross-account backup.
DescribeCrossAccountsDescribeCrossAccounts
DeleteUdmEcsInstanceDeleteUdmEcsInstanceStops protection for Elastic Compute Service (ECS) instance backup.