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