接口介绍
根据主机ID查询备份客户端信息(其中包括未安装客户端)，用户输入备份客户端ID或者主机ID，查询备份客户端信息。
接口约束
无
URI
GET /v4/backup/client-by-instance-backup
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| backupSrcInstanceID | 否 | String | 备份主机ID，可以多个主机","分割 | 参考请求示例 | |
| backupClientID | 否 | String | 备份客户端ID | 参考请求示例 | |
| pageNo | 否 | Integer | 当前页，默认1 | 参考请求示例 | |
| pageSize | 否 | Integer | 每页最多返回，默认10，最大值为50 | 参考请求示例 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 成功或失败时的描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 成功或失败时的描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 否 | Object | 成功时返回对象 | returnObj 表 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | 参考状态码 | |
| error | 否 | String | 业务细分码，为product.module.code三段式大驼峰码 | 参考状态码 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupClientList | 是 | Array of Objects | 列表 | 参考表backupClientList | |
| backupClientTotal | 是 | Integer | 总数 | 参考响应示例 | |
| currentCount | 是 | Integer | 当前页记录数目 | 参考响应示例 | |
| totalCount | 是 | Integer | 总记录数 | 参考响应示例 | |
| totalPage | 是 | Integer | 总页数 | 参考响应示例 |
表 backupClientList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| instacneID | 是 | String | 云主机ID | 参考响应示例 | |
| instanceName | 是 | String | 云主机名称 | 参考响应示例 | |
| instacneIps | 是 | Array of Strings | 云主机Ips | 参考响应示例 | |
| backupClientID | 是 | String | 备份客户端ID | 参考响应示例 | |
| backupClientVersion | 是 | String | 备份客户端版本 | 参考响应示例 | |
| backupClientStatus | 是 | String | 备份客户端状态 | 参考状态枚举值 | |
| backupClientDesc | 是 | String | 备份客户端状态描述 | 参考响应示例 | |
| backupClientUpdateNeed | 是 | Boolean | 备份客户端是否需要升级 | 参考响应示例 | |
| backupClientEnableInstall | 是 | Boolean | 备份客户端是否可安装 | 参考响应示例 | |
| imageName | 是 | String | 云主机镜像名称 | 参考响应示例 | |
| osType | 是 | String | 主机操作系统 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"backupSrcInstanceID":"34d33b5e-f401-aa13-36bb-748564cd9542"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"backupClientList": [
{
"backupClientVersion": "-",
"backupClientEnableInstall": false,
"instacneIps": [
"192.168.0.26"
],
"backupClientID": "fc8c4fbb-5ff8-4d40-8c7c-fe5f299672bf",
"backupClientStatus": "InstallFail",
"osType": "linux",
"instacneID": "34d33b5e-f401-aa13-36bb-748564cd9542",
"imageName": "Ctyunos-2.0.1_yunyi-x86_64-221222",
"backupClientUpdateNeed": false,
"backupClientDesc": "安装失败",
"instanceName": "ecm-ctyun2"
}
],
"backupClientTotal": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
错误码
请参考状态码
| error | description | http status code | message |
|---|---|---|---|
| Openapi.Implementation.Error | 实现错误 | 200 | implmentation error |
| Openapi.RequestParse.EopInvalidRejection | 请求来源非法 | 200 | injected request not expected |
| Openapi.RequestParse.AccessKeyInvalid | 非OpenAPI准入的系统access_key | 200 | access key invalid |
| Openapi.RequestParse.JsonExpected | 请求格式非法 | 400 | request should be http POSTed json |
| Openapi.RequestParse.EmptyRequest | 请求为空 | 400 | request should not be empty |
| Openapi.Common.500 | 内部错误 | 200 | internal error |
| Backup.Admin.AccessFailed | 系统错误 | 200 | access internal service failed |
| Backup.Workorder.AccessFailed | 系统错误 | 200 | access internal service failed |
| Backup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 | 200 | region info empty |
| Backup.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 | 200 | querying region failed |
| Backup.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 | 200 | region info data damaged |
| Backup.Common.ServiceStatusError | 云备份服务状态异常 | 200 | backup service error |
| Backup.Common.ClientAccessError | 云备份客户端信息获取异常: xxx | 200 | backup client info access failed |
| Backup.Parameter.Xxx | 请求参数错误：xxx | 200 | request param error |
