All Products
Search

This Product

    Cloud Backup:UpdateClientSettings

    Document Center

    Cloud Backup:UpdateClientSettings

    Last Updated:Mar 30, 2026

    Updates the settings of a Cloud Backup client.

    Operation description

    This operation applies to both legacy and new Cloud Backup clients.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hbr:UpdateClientSettings

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    UseHttps

    boolean

    No

    Specifies whether to transmit the data on the data plane over HTTPS. Valid values:

    • true: Data is transmitted over HTTPS.

    • false: Data is transmitted over HTTP.

    false
    VaultId

    string

    No

    The ID of the backup vault. This parameter is required for the old HBR client.

    v-*********************
    ClientId

    string

    Yes

    The ID of the HBR client.

    c-*********************
    DataNetworkType

    string

    No

    The type of the endpoint on the data plane. Valid values:

    • PUBLIC: Internet

    • VPC: virtual private cloud (VPC)

    • CLASSIC: classic network

    VPC
    MaxCpuCore

    integer

    No

    The number of CPU cores used by a single backup job. The value 0 indicates that the number is unlimited.

    1
    MaxWorker

    integer

    No

    The number of concurrent backup jobs. The value 0 indicates that the number is unlimited.

    1
    DataProxySetting

    string

    No

    The proxy configuration on the data plane. Valid values:

    • DISABLE: The proxy is not used.

    • USE_CONTROL_PROXY (default): The configuration is the same as that on the control plane.

    • CUSTOM: The configuration is customized (HTTP).

    USE_CONTROL_PROXY
    ProxyHost

    string

    No

    The custom host IP address of the proxy server on the data plane.

    192.168.11.100
    ProxyPort

    integer

    No

    The custom host port of the proxy server on the data plane.

    3128
    ProxyUser

    string

    No

    The custom username of the proxy server on the data plane.

    user
    ProxyPassword

    string

    No

    The custom password of the proxy server on the data plane.

    ******
    ResourceGroupId

    string

    No

    The ID of the resource group.

    rg-*********************
    MaxMemory

    integer

    No

    The maximum memory that can be used by the client. Unit: bytes. Only V2.13.0 and later are supported.

    4096
    AlertOnPartialComplete

    boolean

    No

    Specifies whether to generate alert for partially completed jobs. This parameter is valid only for on-premises file backup and ECS file backup.

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

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

    200
    Message

    string

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

    successful
    RequestId

    string

    The request ID.

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

    boolean

    Indicates whether the request was successful. Valid values:

    • true

    • false

    true

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.