安装备份客户端
更新时间 2026-04-02 15:11:58
最近更新时间: 2026-04-02 15:11:58
接口功能介绍
为指定云主机安装备份客户端
接口约束
1、在一个地域下，每个用户最多保留20个备份客户端(可依据配额动态调整) 2、云主机处于运行中状态 3、备份服务已开通 4、云主机未安装过备份客户端
URI
POST /v4/backup/install-client-backup
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| instanceID | 是 | String | 云主机ID | 82e2defb-3bc8-aa3f-99c7-ccb0aba0fcb0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述 | SUCCESS | |
| description | String | 成功或失败时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码。 | backup.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| installStatus | Boolean | 备份客户端安装命令下发状态 | true |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"instanceID":"82e2defb-3bc8-aa3f-99c7-ccb0aba0fcb0"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"installStatus": true
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
