All Products
Search
Document Center

Hybrid Backup Recovery:UninstallClient

Last Updated:Nov 14, 2022

Uninstalls an HBR backup client.

Operation Description

If you call this operation, the specified HBR backup client is uninstalled. To reinstall the backup client, call the CreateClients operation.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-0008n2q******ax3
ClientIdstringNo

The ID of the backup client.

c-000iuqo******zi3rn
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfm3erpwweavki

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

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

The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of the asynchronous job.

t-0009qs5qcnvuvqrl2mxl
Successboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true

Example

Request example

http(s)://[Endpoint]/?Action=UninstallClient
&VaultId=v-0008n2q******ax3
&ClientId=c-000iuqo******zi3rn
&ResourceGroupId=rg-acfm3erpwweavki
&Common request parameters

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.