调用DeleteBackupClient删除一个备份客户端。

接口说明

  • 不能删除一小时内接收到心跳包的活跃客户端。通过UninstallBackupClients卸载客户端,客户端将变更为非活跃状态。
  • 执行该接口会级联删除与客户端绑定的资源,包括:
    • 备份计划
    • 备份任务
    • 快照

请求参数

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

系统规定参数。取值:DeleteBackupClient

ClientId String c-*********************

客户端ID。

返回数据

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

返回码,200表示成功。

Message String successful

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

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

请求ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。

示例

请求示例

http(s)://[Endpoint]/?Action=DeleteBackupClient
&ClientId=c-*********************
&<公共请求参数>

正常返回示例

XML格式

<DeleteBackupClientResponse>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <Code>200</Code>
  <Success>true</Success>
</DeleteBackupClientResponse>

JSON格式

{
    "Message": "successful",
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "Code": 200,
    "Success": true
}

错误码

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