全部產品
Search
文件中心

Cloud Backup:UpgradeBackupClients - 升級備份用戶端

更新時間:Dec 23, 2025

為一台或者多台ECS執行個體升級備份用戶端。

介面說明

  • 介面將建立一個背景非同步任務,調用雲助手升級 ECS 中備份用戶端。

  • 任務結果可以通過 DescribeTask 獲得。

  • 任務逾時時間為 15 分鐘。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

InstanceIds

object

ECS 執行個體 ID。ECS 執行個體 ID 與備份用戶端識別碼 數量之和不能超過 100 個。

["c-*********************"]

ClientIds

object

備份用戶端識別碼。備份用戶端識別碼 與 ECS 執行個體 ID 數量之和不能超過 100 個。

["i-0xi5wj******3j3bh2gj5"]

CrossAccountType

string

跨帳號備份類型。支援:

  • SELF_ACCOUNT:本帳號備份

  • CROSS_ACCOUNT:跨帳號備份

CROSS_ACCOUNT

CrossAccountUserId

integer

用於跨帳號備份功能中的原帳號 ID。

1283948272xxxxx

CrossAccountRoleName

string

用於跨帳號備份的原帳號 RAM 中建立的角色名稱。

hbrcrossrole

返回參數

名稱

類型

描述

樣本值

object

Code

string

返回碼,200 表示成功。

200

Message

string

返回資訊描述,成功一般返回 successful,錯誤時會返回相應錯誤資訊。

successful

RequestId

string

請求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

TaskId

string

非同步任務 ID。可以通過調用 DescribeTask 擷取任務結果。

t-*********************

Success

boolean

請求是否成功。

  • true 表示成功。

  • false 表示失敗。

true

InstanceStatuses

array<object>

ECS 執行個體狀態。 若存在 ECS 執行個體狀態不滿足安裝用戶端的需求,且請求中 InstanceIds 多於 1 個時,通過這個欄位返回錯誤資訊。

object

ValidInstance

boolean

ECS 執行個體是否可以安裝備份用戶端。

  • true 表示可以安裝。

  • false 表示不可以安裝。

true

InstanceId

string

ECS 執行個體 ID。

i-0xi5w***v3j3bh2gj5

ErrorCode

string

返回錯誤碼。取值範圍:

  • 空表示成功。

  • InstanceNotExists 表示 ECS 執行個體不存在。

  • InstanceNotRunning 表示 ECS 執行個體未處於 Running 狀態。

  • CloudAssistNotRunningOnInstance 表示雲助手不可用。

InstanceNotExists

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-*********************",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-0xi5w***v3j3bh2gj5",
      "ErrorCode": "InstanceNotExists"
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情