All Products
Search
Document Center

:List of operations by function

Last Updated:Sep 22, 2023

The following tables list the API operations that are available for use in Cloud Backup.

Backup vaults

Operation

Description

CreateVault

Creates a backup vault.

CreateReplicationVault

Creates a mirror vault.

DeleteVault

Deletes a backup vault.

DescribeVaults

Queries the information about one or more backup vaults that meet the specified conditions.

UpdateVault

Updates the settings of a backup vault.

Backup clients

Operation

Description

DeleteBackupClient

Deletes a backup client.

DeleteBackupClientResource

Deletes the resources that are related to one or more backup clients.

DescribeBackupClients

Queries the information about one or more backup clients that meet the specified conditions.

InstallBackupClients

Installs a backup client on one or more Elastic Compute Service (ECS) instances.

UninstallBackupClients

Uninstalls a backup client from one or more ECS instances.

UpgradeBackupClients

Upgrades the backup client that is installed on one or more ECS instances.

UpdateClientSettings

Updates the settings of a backup client.

Backup plans

Operation

Description

CreateBackupPlan

Creates a backup plan.

DeleteBackupPlan

Deletes a backup plan.

DescribeBackupPlans

Queries one or more backup plans that meet the specified conditions.

DisableBackupPlan

Disables a backup plan.

EnableBackupPlan

Enables a backup plan.

ExecuteBackupPlan

Executes a backup plan.

UpdateBackupPlan

Updates the settings of a backup plan.

Backup jobs

Operation

Description

CancelBackupJob

Cancels a backup job.

DescribeBackupJobs2

Queries one or more backup jobs that meet the specified conditions.

Backup snapshots

Operation

Description

DeleteSnapshot

Deletes a backup snapshot.

SearchHistoricalSnapshots

Queries one or more historical backup snapshots that meet the specified conditions.

DescribeOtsTableSnapshots

Queries the details about Tablestore instances that are backed up.

DescribeRecoverableOtsInstances

Queries the Tablestore instances that can be restored and the tables in the instances.

Restore jobs

Operation

Description

CancelRestoreJob

Cancels a restore job.

CreateRestoreJob

Creates a restore job.

DescribeRestoreJobs2

Queries one or more restore jobs that meet the specified conditions.

SAP HANA backup

Operation

Description

CreateClients

Installs one or more Cloud Backup clients on specified instances.

CreateHanaBackupPlan

Creates an SAP HANA backup plan.

CreateHanaInstance

Registers an SAP HANA instance.

CreateHanaRestore

Creates a restore job for an SAP HANA database.

DeleteHanaBackupPlan

Deletes an SAP HANA backup plan.

DeleteHanaInstance

Deletes an SAP HANA instance.

DescribeClients

Queries one or more backup clients that meet the specified conditions.

DescribeHanaBackupPlans

Queries one or more SAP HANA backup plans that meet the specified conditions.

DescribeHanaBackupSetting

Queries the backup parameters of an SAP HANA database.

DescribeHanaBackupsAsync

Queries one or more SAP HANA backups that meet the specified conditions.

DescribeHanaDatabases

Queries the information about SAP HANA databases.

DescribeHanaInstances

Queries one or more SAP HANA instances that meet the specified conditions.

DescribeHanaRestores

Queries one or more SAP HANA restore jobs that meet the specified conditions.

DescribeHanaRetentionSetting

Queries the backup retention period of an SAP HANA database.

DisableHanaBackupPlan

Disables an SAP HANA backup plan.

EnableHanaBackupPlan

Enables an SAP HANA backup plan.

StartHanaDatabaseAsync

Starts an SAP HANA database.

StopHanaDatabaseAsync

Stops an SAP HANA database.

UpdateHanaBackupPlan

Updates the settings of an SAP HANA backup plan.

UpdateHanaBackupSetting

Updates the backup parameters of an SAP HANA database.

UpdateHanaInstance

Updates an SAP HANA instance.

UpdateHanaRetentionSetting

Updates the backup retention period of an SAP HANA database.

UpgradeClient

Upgrades a Cloud Backup client.

UninstallClient

Uninstalls a Cloud Backup client.

Other resources

Operation

Description

DescribeTask

Queries an asynchronous job.

DetachNasFileSystem

Deletes a mount target that is created by Cloud Backup.

DescribeRegions

Queries available regions.

DescribeVaultReplicationRegions

Queries the regions that support cross-region replication.

GenerateRamPolicy

Generates a RAM policy.

ChangeResourceGroup

Changes the resource group to which a specified resource belongs.

DescribeUdmSnapshots

Queries the backup snapshots of an Elastic Compute Service (ECS) instance.