Updates the settings of a backup client.

Description

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

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateClientSettings

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

ClientId String Yes c-*********************

The ID of the backup client.

UseHttps Boolean Yes false

Specifies whether to transmit data over HTTPS.

  • true: The system transmits data over HTTPS.
  • false: The system transmits data over HTTP.
VaultId String Yes v-*********************

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

DataNetworkType String No VPC

The network type of the backup client. Valid values:

  • PUBLIC: public network
  • VPC: VPC.
  • CLASSIC: classic network
MaxCpuCore Integer No 1

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

MaxWorker Integer No 1

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

DataProxySetting String No USE_CONTROL_PROXY

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.
ProxyHost String No 192.168.11.100

The custom IP address of the proxy server.

ProxyPort Integer No 3128

The custom port number of the proxy server.

ProxyUser String No user

The custom username of the proxy server.

ProxyPassword String No ******

The custom password of the proxy server.

Response parameters

Parameter Type Example Description
Code String 200

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

Message String successful

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.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Success Boolean true

Indicates whether the request is successful. Valid values:

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

Examples

Sample requests

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

Sample success responses

XML format

<UpdateClientSettingsResponse>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <Code>200</Code>
  <Success>true</Success>
</UpdateClientSettingsResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.