All Products
Search
Document Center

Cloud Backup:UninstallClient

Last Updated:Oct 26, 2026

Uninstalls an HBR backup client.

Operation description

Uninstalls a specified HBR backup 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hbr:UninstallClient

delete

*All Resource

*

None None

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 backup 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 return code. A value of 200 indicates success.

200

Message

string

The return message. successful is returned for a successful request. If an error occurs, the corresponding error message is returned.

successful

RequestId

string

The ID of the request.

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

TaskId

string

The ID of the asynchronous task. You can call the DescribeTask operation to obtain the task result.

t-0009qs5qcnvuvqrl2mxl

Success

boolean

Specifies whether the request is successful. Valid values:

  • true: The request is successful.

  • false: The request failed.

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.