CLI Command Reference

Querying a Single Task

hcloud CBR ShowOpLog

This API is used to query a task by task ID.

Go debug

Querying the Task List

hcloud CBR ListOpLogs

This API is used to query the task list.

Go debug

Obtaining the Share Member List

hcloud CBR ShowMembersDetail

This API is used to obtain the list of backup share members.

Go debug

Adding a Share Member

hcloud CBR AddMember

This API is used to add a member with whom the backup can be shared. Only cloud server backups can be shared among tenants in the same region.

Go debug

Querying Share Member Details

hcloud CBR ShowMemberDetail

This API is used to obtain the details of a backup share member.

Go debug

Updating the Share Member Status

hcloud CBR UpdateMemberStatus

This API is used to update the status of a backup share member.

Go debug

Deleting a Specified Share Member

hcloud CBR DeleteMember

This API is used to delete a specified backup share member.

Go debug

Synchronizing a Restore Point

hcloud CBR ImportCheckpoint

This API is used to synchronize backups for a vault.

Go debug

Querying a Restore Point

hcloud CBR ShowCheckpoint

This API is used to query a specified restore point based on its ID.

Go debug

Replicating a Restore Point

hcloud CBR CopyCheckpoint

This API is used to replicate a restore point.

Go debug

Creating a Restore Point

hcloud CBR CreateCheckpoint

This API is used to back up a vault and generate a restore point.

Go debug

Querying the Vault List

hcloud CBR ListVault

This API is used to query the vault list.

Go debug

Creating a Vault

hcloud CBR CreateVault

This API is used to create a vault.

Go debug

Querying a Specified Vault

hcloud CBR ShowVault

This API is used to query a specified vault based on its ID.

Go debug

Modifying a Vault

hcloud CBR UpdateVault

This API is used to modify a vault based on its ID.

Go debug

Deleting a Vault

hcloud CBR DeleteVault

This API is used to delete vaults. Once a vault is deleted, all backups in the vault are cleared.

Go debug

Dissociating Resources

hcloud CBR RemoveVaultResource

This API is used to dissociate resources from a vault.

Go debug

Associating Resources

hcloud CBR AddVaultResource

This API is used to associate resources with a vault.

Go debug

Binding a Policy to a Vault

hcloud CBR AssociateVaultPolicy

This API is used to bind a policy to a vault.

Go debug

Unbinding a Vault from a Policy

hcloud CBR DisassociateVaultPolicy

This API is used to unbind a vault from a policy.

Go debug

Querying the Vault List in Other Regions

hcloud CBR ListExternalVault

This API is used to query the vault list in other regions.

Go debug

Migrating Resources

hcloud CBR MigrateVaultResource

This API is used to associate resources with another vault and migrate the resource backups to that destination vault.

Go debug

Batch Modifying Vaults

hcloud CBR BatchUpdateVault

This API is used to batch modify all vaults in a project.

Go debug

Creating a Yearly/Monthly Vault

hcloud CBR CreatePostPaidVault

This API is used to create a yearly/monthly vault in a combined purchase. It is an internal API.

Go debug

Setting Auto Backup for a Vault

hcloud CBR SetVaultResource

This API is used to enable or disable auto backup for a vault.

Go debug

Synchronizing a Backup

hcloud CBR ImportBackup

This API is used to synchronize on-premises VMware backups.

Go debug

Querying a Specified Backup

hcloud CBR ShowBackup

This API is used to query the backup of a specific ID.

Go debug

Modifying a Backup Name

hcloud CBR UpdateBackup

This API is used to modify a backup name based on a given backup ID.

Go debug

Deleting a Backup

hcloud CBR DeleteBackup

This API is used to delete a single backup.

Go debug

Querying All Backups

hcloud CBR ListBackups

This API is used to query all backups.

Go debug

Replicating a Backup

hcloud CBR CopyBackup

This API is used to replicate a backup across regions.

Go debug

Restoring a Backup

hcloud CBR RestoreBackup

This API is used to restore backup data.

Go debug

Querying Backup Metadata

hcloud CBR ShowMetadata

This API is used to query the metadata of the resources that are backed up.

Go debug

Querying the Policy List

hcloud CBR ListPolicies

This API is used to query the policy list.

Go debug

Creating a Policy

hcloud CBR CreatePolicy

This API is used to create a policy. Policies are classified into backup policies and replication policies.

Go debug

Querying a Single Policy

hcloud CBR ShowPolicy

This API is used to query a single policy.

Go debug

Modifying a Policy

hcloud CBR UpdatePolicy

This API is used to modify a policy.

Go debug

Deleting a Policy

hcloud CBR DeletePolicy

This API is used to delete a policy.

Go debug

Querying Protectable Resources

hcloud CBR ListProtectable

This API is used to query the list of resources that can be protected.

Go debug

Querying the Agent Status

hcloud CBR CheckAgent

This API is used to check the Agent status required by application-consistent.

Go debug

Querying a Specified Protectable Resource

hcloud CBR ShowProtectable

This API is used to query a specified resource that can be protected by its ID.

Go debug

Querying the Replication Capability

hcloud CBR ShowReplicationCapabilities

This API is used to query the replication capability of the current region.

Go debug

This API is used to query the project information of a tenant.

hcloud CBR ListProjects

This API is used to query the enterprise project information of a tenant.

Go debug

Querying the Project List of a Tenant

hcloud CBR ListDomainProjects

This API is used to query the project list based on a specified tenant name.

Go debug

Querying Tenant Information

hcloud CBR ShowDomain

This is an internal API called by the console. It is used to obtain the domain name of the source project ID only when querying a shared backup.

Go debug

Querying the Migration

hcloud CBR ShowMigrateStatus

This API is used to query the migration result.

Go debug

Querying Vault Resources

hcloud CBR ShowVaultResourceInstances

This API is used to filter resources by tag.

Go debug

Batch Adding or Deleting Tags of a Vault

hcloud CBR BatchCreateAndDeleteVaultTags

This API is used to add or delete tags for a specified resource in batches.

Go debug

Querying Tags of an Associated Resource

hcloud CBR ShowVaultTag

This API is used to query tags of a specified resource.

Go debug

Adding a Tag to an Associated Resource

hcloud CBR CreateVaultTags

This API is used to add a tag to an associated resource. A resource can have a maximum of 10 tags.

Go debug

Deleting a Tag from an Associated Resource

hcloud CBR DeleteVaultTag

This API is used to delete a tag from an associated resource. The API is idempotent. When you delete a nonexistent tag, error code 404 will be returned. Tag keys cannot be empty or be empty character strings.

Go debug

Querying Tags of a Vault Project

hcloud CBR ShowVaultProjectTag

This API is used to query a tenant's tag set in a specific region and of a specific instance type.

Go debug

Querying Capacity Statistics

hcloud CBR ShowStorageUsage

This API is used to query capacity statistics.

Go debug

Change

hcloud CBR ChangeOrder

This API is used to update the order information of a yearly/monthly product and return the information about the order to be paid.

Go debug

Change(Abandoned)

hcloud CBR UpdateOrder

Used for updating yearly/monthly subscription order information

Go debug

Changing the Payment Mode

hcloud CBR ChangeVaultChargeMode

This API is used to change the billing mode of a resource. Currently, only pay-per-use resources can be changed to yearly/monthly resources.

Go debug

Querying the Organizational Policy List

hcloud CBR ListOrganizationPolicies

This API is used to query the organizational policy list.

Go debug

Creating an Organization Policy

hcloud CBR CreateOrganizationPolicy

This API is used to create an organization policy.

Go debug

Querying a Specified Organizational Policy

hcloud CBR ShowOrganizationPolicy

This API is used to query a specified organizational policy.

Go debug

Updating an Organization Policy

hcloud CBR UpdateOrganizationPolicy

This API is used to update an organization policy.

Go debug

Deleting an Organization Policy

hcloud CBR DeleteOrganizationPolicy

This API is used to delete an organization policy.

Go debug

Querying Organizational Policy Delivery Info

hcloud CBR ListOrganizationPolicyDetail

This API is used to query the organization policy delivery info of each account.

Go debug

Adding File Paths

hcloud CBR AddAgentPath

This API is used to add the file paths you want to back up from a client. Path validity will not be checked.

Go debug

Querying a Specified Client

hcloud CBR ShowAgent

This API is used to query a specified client.

Go debug

Modifying a Client

hcloud CBR UpdateAgent

This API is used to change the status of a client.

Go debug

Removing a Client

hcloud CBR UnregisterAgent

This API is used to remove a client. All backups of a client will be deleted after the client is removed.

Go debug

Querying the Client List

hcloud CBR ListAgent

This API is used to query the client list.

Go debug

Registering a Client

hcloud CBR RegisterAgent

This API is used to register a client during agent installation. This API is called automatically by the Agent. Manual registration is not required.

Go debug

Removing File Paths

hcloud CBR RemoveAgentPath

This API is used to remove the file paths added for backup.

Go debug

Tenant Migration

hcloud CBR MigrateDomain

This API is used to migrate CSBS or VBS resources to CBR.

Go debug

Querying Vault Usage of a Tenant

hcloud CBR ShowSummary

This API is used to query the total capacity and used capacity of all vaults of a tenant.

Go debug

Querying Features Supported by CBR

hcloud CBR ListFeatures

Querying Features Supported by CBR

Go debug

Querying a Specific Feature

hcloud CBR ShowFeature

This API is used to query a specified feature supported by CBR.

Go debug