All Products
Search

This Product

    Cloud Backup:UpdateClientSettings

    Document Center

    Cloud Backup:UpdateClientSettings

    Last Updated:Nov 06, 2024

    Updates the configurations of an HBR client.

    Operation description

    You can call this operation to update the configurations of both the old and new HBR clients.

    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:UpdateClientSettingsupdate
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    UseHttpsbooleanYes

    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
    VaultIdstringYes

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

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

    The ID of the HBR client.

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

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

    • PUBLIC: Internet
    • VPC: virtual private cloud (VPC)
    • CLASSIC: classic network
    		VPC
    MaxCpuCoreintegerNo

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

    		1
    MaxWorkerintegerNo

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

    		1
    DataProxySettingstringNo

    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
    ProxyHoststringNo

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

    		192.168.11.100
    ProxyPortintegerNo

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

    		3128
    ProxyUserstringNo

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

    		user
    ProxyPasswordstringNo

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

    		******
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-*********************
    MaxMemorylongNo

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

    		4096
    AlertOnPartialCompletebooleanNo

    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 parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The HTTP status 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.

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

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history