通过主机id查询云备份客户端
更新时间 2026-04-02 15:43:36
最近更新时间: 2026-04-02 15:43:36
接口功能介绍
根据主机ID查询备份客户端信息(其中包括未安装客户端),用户输入的备份客户端ID或者主机ID,查询备份客户端信息
接口约束
无
URI
GET /v4/backup/client-by-instance-backup
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| backupSrcInstanceID | 否 | String | 备份主机ID,可以多个主机","分割 | 34d33b5e-f401-aa13-36bb-748564cd9542 | |
| backupClientID | 否 | String | 备份客户端ID | fc8c4fbb-5ff8-4d40-8c7c-fe5f299672bf | |
| pageNo | 否 | Integer | 当前页,默认1 | 1 | |
| pageSize | 否 | Integer | 每页最多返回,默认10,最大值为50 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupClientList | Array of Objects | 列表 | backupClientList表 | |
| backupClientTotal | Integer | 总数 | 1 | |
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 1 | |
| totalPage | Integer | 总页数 | 1 |
表 backupClientList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instacneID | String | 主机ID。推荐使用instanceID参数,该参数后续即将下线 | 34d33b5e-f401-aa13-36bb-748564cd9542 | |
| instanceID | String | 主机ID | 34d33b5e-f401-aa13-36bb-748564cd9542 | |
| instacneIps | Array of Strings | 主机ip。推荐使用instanceIps参数,该参数后续即将下线 | ["192.168.0.26"] | |
| instanceIps | String | 主机Ips | ["192.168.0.26"] | |
| backupClientID | String | 备份客户端ID | fc8c4fbb-5ff8-4d40-8c7c-fe5f299672bf | |
| backupClientName | String | 主机/客户端名称 | fh-cloud-computer | |
| backupClientVersion | String | 备份客户端版本 | - | |
| backupClientStatus | String | 备份客户端状态 | InstallFail | |
| backupClientDesc | String | 备份客户端状态描述 | 安装失败 | |
| backupClientUpdateNeed | Boolean | 备份客户端是否需要升级 | false | |
| backupClientEnableInstall | Boolean | 备份客户端是否可安装 | false | |
| imageName | String | 主机镜像名称 | Ctyunos-2.0.1_yunyi-x86_64-221222 | |
| osType | String | 主机操作系统 | linux | |
| backupClientType | Integer | 客户端类型,0:云上 1:本地 3:物理机 | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"backupSrcInstanceID":"34d33b5e-f401-aa13-36bb-748564cd9542"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"backupClientList": [
{
"backupClientVersion": "v2.14.0",
"backupClientEnableInstall": false,
"instacneIps": [
"10.0.0.4"
],
"backupClientID": "db27dbdf-fc59-4959-915e-9caa62b46efa",
"backupClientStatus": "Activated",
"osType": "linux",
"instacneID": "12bb64eb-ae06-d544-4deb-0f71dce62316",
"imageName": "Ubuntu-Server_20.04",
"backupClientUpdateNeed": false,
"backupClientType": 0,
"backupClientDesc": "已激活",
"backupClientName": "ecm-9901"
}
],
"backupClientTotal": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码