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

接口说明

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

请求参数

名称 类型 是否必选 示例值 描述
Action String InstallBackupClients

系统规定参数。取值:InstallBackupClients

InstanceIds Json ["i-0xi5wj5*****v3j3bh2gj5"]

ECS实例ID。最多20个。

返回数据

名称 类型 示例值 描述
Code String 200

返回码。200表示成功。

InstanceStatuses Array of InstanceStatuses

ECS实例状态。

ErrorCode String InstanceNotExists

返回错误码。取值范围:

  • 空表示成功。
  • InstanceNotExists表示ECS实例不存在。
  • InstanceNotRunning表示ECS实例未处于Running状态。
  • CloudAssistNotRunningOnInstance表示云助手不可用。
InstanceId String i-0xi5w***v3j3bh2gj5

ECS实例ID。

ValidInstance Boolean true

ECS实例是否可以安装备份客户端。

  • true表示可以安装。
  • false表示不可以安装。
Message String successful

返回信息描述,成功一般返回successful,错误时会返回相应错误信息。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。
TaskId String t-*********************

异步任务ID。可以通过调用DescribeTask获取任务结果。

示例

请求示例

http(s)://[Endpoint]/?Action=InstallBackupClients
&InstanceIds=["i-0xi5wj5*****v3j3bh2gj5"]
&<公共请求参数>

正常返回示例

XML格式

<InstallBackupClientsResponse>
  <TaskId>t-*********************</TaskId>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <Message>successful</Message>
  <InstanceStatuses>
        <InstanceId>i-0xi5w***v3j3bh2gj5</InstanceId>
        <ErrorCode>InstanceNotExists</ErrorCode>
        <ValidInstance>true</ValidInstance>
  </InstanceStatuses>
  <Code>200</Code>
  <Success>true</Success>
</InstallBackupClientsResponse>

JSON格式

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

错误码

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