文档

UpdateClientSettings - 更新客户端配置

更新时间:

更新一个备份客户端的配置。

接口说明

适用于更新旧版和新版客户端。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
UseHttpsboolean

是否使用 HTTPS 传输数据面数据。

  • true 表示使用 HTTPS 传输。
  • false 表示使用 HTTP 传输。
false
VaultIdstring

备份仓库 ID。旧版客户端时该参数必须配置。

v-*********************
ClientIdstring

备份客户端 ID。

c-*********************
DataNetworkTypestring

数据面数据接入点类型。取值范围:

  • PUBLIC:公网
  • VPC:VPC 网络
  • CLASSIC:经典网络
VPC
MaxCpuCoreinteger

单个备份任务使用的 CPU 核数,0 表示不限制。

1
MaxWorkerinteger

单个备份任务并发工作数量,0 表示不限制。

1
DataProxySettingstring

数据面代理设置。取值范围:

  • DISABLE:不使用代理
  • USE_CONTROL_PROXY(默认):与控制面配置相同
  • CUSTOM:自定义配置(HTTP 协议)
USE_CONTROL_PROXY
ProxyHoststring

自定义数据面代理服务器主机 IP 地址。

192.168.11.100
ProxyPortinteger

自定义数据面代理服务器主机端口。

3128
ProxyUserstring

自定义数据面代理服务器用户名。

user
ProxyPasswordstring

自定义数据面代理服务器密码。

******
ResourceGroupIdstring

资源组 ID。

rg-*********************
MaxMemorylong

客户端能够使用的最大内存,单位是 bytes。仅支持 2.13.0 及以上版本。

4096
AlertOnPartialCompleteboolean

是否针对部分完成任务告警,仅针对本地文件备份和 ECS 文件备份生效。

false

返回参数

名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
RequestIdstring

请求 ID。

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

请求是否成功。

  • true 表示成功。
  • false 表示失败。
true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史