全部產品
Search
文件中心

Cloud Backup:UpdateClientSettings

更新時間:Aug 06, 2026

更新一個備份用戶端的配置。

介面說明

適用於更新舊版和新版用戶端。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:UpdateClientSettings

update

*全部資源。

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

UseHttps

boolean

否

是否使用 HTTPS 傳輸資料面資料。

  • true 表示使用 HTTPS 傳輸。

  • false 表示使用 HTTP 傳輸。

false

VaultId

string

否

備份儲存庫 ID。舊版用戶端時該參數必須配置。

v-*********************

ClientId

string

是

備份用戶端 ID。

c-*********************

DataNetworkType

string

否

資料面資料存取點類型。取值範圍:

  • PUBLIC:公網

  • VPC:VPC 網路

  • CLASSIC:傳統網路

VPC

MaxCpuCore

integer

否

單個備份工作使用的 CPU 核心數,0 表示不限制。

1

MaxWorker

integer

否

單個備份工作並行工作數量,0 表示不限制。

1

DataProxySetting

string

否

資料面代理設定。取值範圍:

  • DISABLE:不使用代理

  • USE_CONTROL_PROXY(預設):與控制面配置相同

  • CUSTOM:自訂配置(HTTP 協定)

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 表示成功。

  • false 表示失敗。

true

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。