更新一个备份客户端的配置。
接口说明
适用于更新旧版和新版客户端。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
hbr:UpdateClientSettings |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| UseHttps |
boolean |
否 |
是否使用 HTTPS 传输数据面数据。
|
false |
| VaultId |
string |
否 |
备份仓库 ID。旧版客户端时该参数必须配置。 |
v-********************* |
| ClientId |
string |
是 |
备份客户端 ID。 |
c-********************* |
| DataNetworkType |
string |
否 |
数据面数据接入点类型。取值范围：
|
VPC |
| MaxCpuCore |
integer |
否 |
单个备份任务使用的 CPU 核数，0 表示不限制。 |
1 |
| MaxWorker |
integer |
否 |
单个备份任务并发工作数量，0 表示不限制。 |
1 |
| DataProxySetting |
string |
否 |
数据面代理设置。取值范围：
|
USE_CONTROL_PROXY |
| ProxyHost |
string |
否 |
自定义数据面代理服务器主机 IP 地址。 |
192.168.11.100 |
| ProxyPort |
integer |
否 |
自定义数据面代理服务器主机端口。 |
3128 |
| ProxyUser |
string |
否 |
自定义数据面代理服务器用户名。 |
user |
| ProxyPassword |
string |
否 |
自定义数据面代理服务器密码。 |
****** |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-********************* |
| MaxMemory |
integer |
否 |
客户端能够使用的最大内存，单位是 bytes。仅支持 2.13.0 及以上版本。 |
4096 |
| AlertOnPartialComplete |
boolean |
否 |
是否针对部分完成任务告警，仅针对本地文件备份和 ECS 文件备份标准版生效。 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
返回码，200 表示成功。 |
200 |
| Message |
string |
返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。 |
successful |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Success |
boolean |
请求是否成功。
|
true |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。