All Products
Search
Document Center

Cloud Backup:UninstallClient

Last Updated:Aug 28, 2026

Uninstalls an HBR client.

Operation description

Uninstalls the specified HBR client. To reinstall the client, call the CreateClients operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

VaultId

string

No

The ID of the backup vault.

v-0008n2q******ax3

ClientId

string

Yes

The ID of the HBR client.

c-000iuqo******zi3rn

ResourceGroupId

string

No

The ID of the resource group.

rg-acfm3erpwweavki

Response elements

Element

Type

Description

Example

object

Code

string

The HTTP status code. 200 indicates success.

200

Message

string

The response message. Returns "successful" on success or an error message on failure.

successful

RequestId

string

The request ID.

048A2164-3732-5DF5-88B5-F97FA56DAEB1

TaskId

string

The asynchronous job ID. Call DescribeTask to query the job result.

t-0009qs5qcnvuvqrl2mxl

Success

boolean

Whether the call succeeded. Valid values:

  • true: Success.

  • false: Failure.

true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "048A2164-3732-5DF5-88B5-F97FA56DAEB1",
  "TaskId": "t-0009qs5qcnvuvqrl2mxl",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.