調用InstallBackupClients為ECS執行個體安裝備份用戶端-雲備份-阿里雲

介面說明

該介面將建立一個背景非同步任務，調用雲助手在 ECS 執行個體中安裝備份用戶端。
任務結果可以通過 DescribeTask 獲得。
任務逾時時間為 15 分鐘。建議任務建立 60 秒後，再首次查詢，每 30 秒查詢一次結果。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:InstallBackupClients

update

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceIds	object	是	ECS 執行個體 ID。最多 20 個。	["i-0xi5wj5*****v3j3bh2gj5"]
CrossAccountType	string	否	跨帳號備份類型。支援： SELF_ACCOUNT：本帳號備份 CROSS_ACCOUNT：跨帳號備份	CROSS_ACCOUNT
CrossAccountUserId	integer	否	用於跨帳號備份功能中的原帳號 ID。	16392782xxxxxx
CrossAccountRoleName	string	否	用於跨帳號備份的原帳號 RAM 中建立的角色名稱。	BackupRole

返回參數

名稱	類型	描述	樣本值
	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 執行個體狀態。
	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"
    }
  ]
}

錯誤碼

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

變更歷史

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