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

接口说明

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateClientSettings

系统规定参数。取值:UpdateClientSettings

ClientId String c-*********************

备份客户端ID。

UseHttps Boolean false

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

  • true表示使用HTTPS传输。
  • false表示使用HTTP传输。
VaultId String v-*********************

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

DataNetworkType String VPC

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

  • PUBLIC:公网
  • VPC:VPC网络
  • CLASSIC:经典网络
MaxCpuCore Integer 1

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

MaxWorker Integer 1

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

DataProxySetting String USE_CONTROL_PROXY

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

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

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

ProxyPort Integer 3128

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

ProxyUser String user

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

ProxyPassword String ******

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

返回数据

名称 类型 示例值 描述
Code String 200

返回码,200表示成功。

Message String successful

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

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Success Boolean true

请求是否成功。

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

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateClientSettings
&ClientId=c-*********************
&UseHttps=false
&VaultId=v-*********************
&<公共请求参数>

正常返回示例

XML格式

<UpdateClientSettingsResponse>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <Code>200</Code>
  <Success>true</Success>
</UpdateClientSettingsResponse>

JSON格式

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

错误码

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