UpgradeBackupClients - 升级备份客户端

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hbr:UpgradeBackupClients
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdsobject

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

["c-*********************"]
ClientIdsobject

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

["i-0xi5wj******3j3bh2gj5"]
CrossAccountTypestring

跨账号备份类型。支持:

  • SELF_ACCOUNT:本账号备份
  • CROSS_ACCOUNT:跨账号备份
CROSS_ACCOUNT
CrossAccountUserIdlong

用于跨账号备份功能中的原账号 ID。

1283948272xxxxx
CrossAccountRoleNamestring

用于跨账号备份的原账号 RAM 中创建的角色名。

hbrcrossrole

返回参数

名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskIdstring

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

t-*********************
Successboolean

请求是否成功。

  • true 表示成功。
  • false 表示失败。
true
InstanceStatusesarray<object>

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

object
ValidInstanceboolean

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

  • true 表示可以安装。
  • false 表示不可以安装。
true
InstanceIdstring

ECS 实例 ID。

i-0xi5w***v3j3bh2gj5
ErrorCodestring

返回错误码。取值范围:

  • 空表示成功。
  • 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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史