All Products
Search
Document Center

Hybrid Backup Recovery:UpgradeClient

Last Updated:Nov 14, 2022

Upgrades an HBR backup client.

Operation Description

You can call this operation to upgrade a backup client to the latest version. After the backup client is upgraded, the version of the backup client cannot be rolled back.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-000djw8ci******3ic
ClientIdstringNo

The ID of the backup client.

c-000boklw******63a9
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmy6uja5wyc2i

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.

22D97921-16BD-547C-B175-1DC25B1DCD73
TaskIdstring

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

t-000i97jujk0z58a2ignf
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=UpgradeClient
&VaultId=v-000djw8ci******3ic
&ClientId=c-000boklw******63a9
&ResourceGroupId=rg-acfmy6uja5wyc2i
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "22D97921-16BD-547C-B175-1DC25B1DCD73",
  "TaskId": "t-000i97jujk0z58a2ignf",
  "Success": true
}

Error codes

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