UpdateClientSettings_云备份 Cloud Backup_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为600/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
hbr:UpdateClientSettings
Update
全部资源
*

请求参数

字段名称字段详情
UseHttpsboolean

是否使用 HTTPS 传输数据面数据。展开详情

示例值:false
VaultIdstring

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

示例值:v-*********************参考取值来源:
    CreateVault
    DescribeVaults
ClientIdstring

备份客户端 ID。

示例值:c-*********************参考取值来源:
    DescribeClients
DataNetworkTypestring

数据面数据接入点类型。取值范围:展开详情

示例值:VPC
MaxCpuCoreinteger<int32>

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

示例值:1取值 <= 999
MaxWorkerinteger<int32>

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

示例值:1取值 <= 999
DataProxySettingstring

数据面代理设置。取值范围:展开详情

示例值:USE_CONTROL_PROXY枚举值:DISABLEUSE_CONTROL_PROXYCUSTOM
ProxyHoststring

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

示例值:192.168.11.100
ProxyPortinteger<int32>

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

示例值:3128取值 <= 65536
ProxyUserstring

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

示例值:user
ProxyPasswordstring

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

示例值:******
ResourceGroupIdstring

资源组 ID。

示例值:rg-*********************
MaxMemoryinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:4096取值 <= 1099511627776
AlertOnPartialCompleteboolean

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

示例值:false

返回参数

字段名称字段详情
Codestring

返回码,200 表示成功。

示例值:200
Messagestring

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

示例值:successful
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

请求是否成功。展开详情

示例值:true

返回示例

变更历史

暂无变更历史

相关示例