全部产品
Search
文档中心

云备份:UninstallBackupClients - 卸载备份客户端

更新时间:Mar 03, 2024

为一台或者多台ECS实例卸载备份客户端。

接口说明

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

调试

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

授权信息

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

请求参数

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

ECS 实例 ID。最多 20 个。

["i-0xi5wj5*****v3j3bh2gj5"]
ClientIdsobject

备份客户端 ID。客户端 ID 与 ECS 实例 ID 的数量之和不能超过 20 个,否则报错。

["c-*********************"]
CrossAccountTypestring

跨账号备份类型。支持:

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

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

129349237xxxxx
CrossAccountRoleNamestring

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

BackupRole

返回参数

名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 ID。

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

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

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

请求是否成功。

  • true 表示成功。
  • false 表示失败。
true
InstanceStatusesobject []

ECS 实例状态。

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"
    }
  ]
}

错误码

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

变更历史

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