调用InstallBackupClients安装备份客户端_混合云备份服务-阿里云帮助中心

为一台或者多台ECS实例安装备份客户端。

接口说明

该接口将创建一个后台的异步任务，调用云助手在ECS实例中安装备份客户端。
任务结果可以通过DescribeTask获得。
任务超时时间为15分钟。建议任务创建60秒后，再首次查询，每30秒查询一次结果。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceIds	object	是	ECS实例ID。最多20个。
CrossAccountType	string	否	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	CROSS_ACCOUNT
CrossAccountUserId	long	否	用于跨账号备份功能中的原账号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	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"
    }
  ]
}

错误码

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