调用UpgradeBackupClients为一台或者多台ECS实例升级备份客户端。

接口说明

  • 接口将创建一个后台的异步任务,调用云助手升级ECS中备份客户端。
  • 任务结果可以通过DescribeTask获得。
  • 任务超时时间为15分钟。

请求参数

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

系统规定参数。取值:UpgradeBackupClients

InstanceIds Map ["c-*********************"]

备份客户端ID。备份客户端ID与ECS实例ID数量之和不能超过100个。

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

ECS实例ID。ECS实例ID与备份客户端ID数量之和不能超过100个。

返回数据

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

返回码,200表示成功。

Message String successful

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

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

请求ID。

TaskId String t-*********************

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

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。
InstanceStatuses Array of InstanceStatuses

ECS实例状态。

若存在ECS实例状态不满足安装客户端的需求,且请求中InstanceIds多于1个时,通过这个字段返回错误信息。

ValidInstance Boolean true

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

  • true表示可以安装。
  • false表示不可以安装。
InstanceId String i-0xi5w***v3j3bh2gj5

ECS实例ID。

ErrorCode String InstanceNotExists

返回错误码。取值范围:

  • 空表示成功。
  • InstanceNotExists表示ECS实例不存在。
  • InstanceNotRunning表示ECS实例未处于Running状态。
  • CloudAssistNotRunningOnInstance表示云助手不可用。

示例

请求示例

http(s)://[Endpoint]/?Action=UpgradeBackupClients
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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