接口介绍
为指定云主机卸载备份客户端
接口约束
1、云主机处于运行中状态
2、云主机有备份客户端
URI
POST /v4/backup/uninstall-client-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
backupClientID | 是 | String | 备份客户端ID,目前只支持一个。 | 参考请求示例 | |
regionID | 是 | String | 资源池ID。 | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为处理中/失败) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码。 | 参考状态码 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
status | 是 | String | 客户端卸载状态 | 参考状态枚举表 |
请求示例
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"backupClientID":"0ae97ef5-6ee2-44af-9d05-1a509b0a1be6"
}
响应示例
{
"returnObj": {
"UninstallStatus": "uninstalled",
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码