Upgrades an HBR backup client.

Usage notes

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.

Request parameters

Parameter Type Required Example Description
Action String Yes UpgradeClient

The operation that you want to perform. Set the value to UpgradeClient.

VaultId String No v-000djw8ci******3ic

The ID of the backup vault.

ClientId String No c-000boklw******63a9

The ID of the backup client.

ResourceGroupId String No rg-acfmy6uja5wyc2i

The ID of the resource group.

Response parameters

Parameter Type Example Description
Code String 200

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

Message String successful

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

RequestId String 22D97921-16BD-547C-B175-1DC25B1DCD73

The ID of the request.

TaskId String t-000i97jujk0z58a2ignf

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

Success Boolean true

Indicates whether the call is successful. Valid values:

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpgradeClient
&VaultId=v-000djw8ci******3ic
&ClientId=c-000boklw******63a9
&ResourceGroupId=rg-acfmy6uja5wyc2i
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpgradeClientResponse>
    <Code>200</Code>
    <Message>successful</Message>
    <RequestId>22D97921-16BD-547C-B175-1DC25B1DCD73</RequestId>
    <TaskId>t-000i97jujk0z58a2ignf</TaskId>
    <Success>true</Success>
</UpgradeClientResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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.