All Products
Search
Document Center

Cloud Backup:UpgradeClient

Last Updated:Dec 19, 2024

Upgrades the Cloud Backup client.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
hbr:UpgradeClientupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

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

The ID of the Cloud Backup client.

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

The ID of the resource group.

rg-acfmy6uja5wyc2i

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The response code. The status code 200 indicates that the request was successful.

200
Messagestring

The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.

successful
RequestIdstring

The request ID.

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

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

t-000i97jujk0z58a2ignf
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

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 Service error codes.

Change history

Change timeSummary of changesOperation
No change history