更新一個備份客戶端的配置。
接口說明
適用于更新舊版和新版客戶端。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| 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 | long | 否 | 客戶端能夠使用的最大內存，單位是 bytes。僅支持 2.13.0 及以上版本。 | 4096 |
| AlertOnPartialComplete | boolean | 否 | 是否針對部分完成任務告警，僅針對本地文件備份和 ECS 文件備份生效。 | false |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史