All Products
Search

This Product

    Cloud Backup:UpdateClientSettings

    Document Center

    Cloud Backup:UpdateClientSettings

    Last Updated:Aug 06, 2026

    Updates the configuration of a backup client.

    Operation description

    Applies to updating both legacy and new 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 use HTTPS to transmit data plane data.

    • true: Uses HTTPS for transmission.

    • false: Uses HTTP for transmission.

    false
    VaultId

    string

    No

    The backup vault ID. This parameter is required for legacy clients.

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

    string

    Yes

    The backup client ID.

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

    string

    No

    The data plane access point type. Valid values:

    • PUBLIC: public network

    • VPC: VPC network

    • CLASSIC: classic network

    VPC
    MaxCpuCore

    integer

    No

    The number of CPU cores used by a single backup job. A value of 0 indicates no limit.

    1
    MaxWorker

    integer

    No

    The number of concurrent workers for a single backup job. A value of 0 indicates no limit.

    1
    DataProxySetting

    string

    No

    The data plane proxy setting. Valid values:

    • DISABLE: does not use a proxy.

    • USE_CONTROL_PROXY (default): uses the same configuration as the control plane.

    • CUSTOM: uses a custom configuration (HTTP protocol).

    USE_CONTROL_PROXY
    ProxyHost

    string

    No

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

    192.168.11.100
    ProxyPort

    integer

    No

    The port of the custom data plane proxy server host.

    3128
    ProxyUser

    string

    No

    The username of the custom data plane proxy server.

    user
    ProxyPassword

    string

    No

    The password of the custom data plane proxy server.

    ******
    ResourceGroupId

    string

    No

    The resource group ID.

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

    integer

    No

    The maximum memory that the client can use, in bytes. Only version 2.13.0 and later are supported.

    4096
    AlertOnPartialComplete

    boolean

    No

    Specifies whether to trigger an alert for partially completed jobs. This parameter takes effect only for local File Backup and ECS File Backup Essential Edition.

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The response code. 200 indicates success.

    200
    Message

    string

    The response message. "successful" is returned for success. An error message is returned for failure.

    successful
    RequestId

    string

    The request ID.

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

    boolean

    Indicates whether the request was successful.

    • true: The request was successful.

    • false: The request failed.

    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.