All Products
Search
Document Center

Hybrid Backup Recovery:UpdateClientSettings

Last Updated:Nov 14, 2022

Updates the settings of a backup client.

Operation Description

You can call this operation to update the settings of a backup client of an earlier version or the latest version.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
UseHttpsbooleanYes

Specifies whether to transmit data over HTTPS.

  • true: The system transmits data over HTTPS.
  • false: The system transmits data over HTTP.
false
VaultIdstringYes

The ID of the backup vault. If you use a backup client of an earlier version, you must set this parameter.

v-*********************
ClientIdstringYes

The ID of the backup client.

c-*********************
DataNetworkTypestringNo

The network type of the backup client. Valid values:

  • PUBLIC: public network
  • VPC: VPC.
  • CLASSIC: classic network
VPC
MaxCpuCoreintegerNo

The number of CPU cores that can be used by a single backup job. A value of 0 indicates no limits.

1
MaxWorkerintegerNo

The number of concurrent tasks that can be included in a backup job. A value of 0 indicates no limits.

1
DataProxySettingstringNo

The proxy settings of the backup client. Valid values:

  • DISABLE: No proxy is configured.
  • **USE_CONTROL_PROXY **: The proxy settings are the same as the settings that are predefined by the system. Default value: USE_CONTROL_PROXY.
  • CUSTOM: Custom HTTP proxy settings are configured.
USE_CONTROL_PROXY
ProxyHoststringNo

The custom IP address of the proxy server.

192.168.11.100
ProxyPortintegerNo

The custom port number of the proxy server.

3128
ProxyUserstringNo

The custom username of the proxy server.

user
ProxyPasswordstringNo

The custom password of the proxy server.

******
ResourceGroupIdstringNo

The ID of resource group.

rg-*********************

Response parameters

ParameterTypeDescriptionExample
object
Codestring

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

200
Messagestring

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

Indicates whether the request is successful. Valid values:

  • true: indicates that the request is successful.
  • false: indicates that the request fails.
true

Example

Request example

http(s)://[Endpoint]/?Action=UpdateClientSettings
&ClientId=c-*********************
&UseHttps=false
&VaultId=v-*********************
&<Common request parameters>

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true
}

Error codes

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