调用InstallBackupClients安装备份客户端_云备份(Cloud Backup)-阿里云帮助中心

接口说明

该接口将创建一个后台的异步任务，调用云助手在 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"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。