查询备份客户端信息
更新时间 2026-04-02 15:32:42
最近更新时间: 2026-04-02 15:32:42
接口功能介绍
查询一个或者多个备份客户端信息 ，根据用户输入的备份客户端ID，查询该备份客户端信息，如不指定备份客户端ID，则获取该用户该资源池下所有云主机的备份客户端信息列表
接口约束
无
URI
GET /v4/backup/info-client-backup
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| backupClientID | 否 | String | 备份客户端ID | 34d33b5e-f401-aa13-36bb-748564cd9542 | |
| queryContent | 否 | String | 可选查询：主机名称/ID | test-ecs | |
| pageNo | 否 | Integer | 当前页，默认1 | 1 | |
| pageSize | 否 | Integer | 每页最多返回，默认10，最大值为50 | 10 | |
| isCloud | 否 | Boolean | 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。该参数后续即将下线，推荐使用sourceType参数 | true | |
| sourceType | 否 | String | 产品服务类型(默认CT-ECS)，CT-ECS：弹性云主机，CT-DPS：裸金属物理机，CT-LS：本地客户主机 | CT-DPS | |
| notOnlyInstalled | 否 | Boolean | 是否返回未安装的备份客户端与主机信息(默认false) | false |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 |
表 backupClientList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instacneID | String | 主机ID。推荐使用instanceID参数，该参数后续即将下线 | 34d33b5e-f401-aa13-36bb-748564cd9542 | |
| instanceID | String | 主机ID | 34d33b5e-f401-aa13-36bb-748564cd9542 | |
| instanceName | String | 主机名称 | ecm-ctyun2 | |
| instacneIps | Array of Strings | 主机ip。推荐使用backupStorageCreateTime参数，该参数后续即将下线 | ["192.168.0.26"] | |
| instanceIps | String | 主机ip | ["192.168.0.26"] | |
| backupClientID | String | 备份客户端ID | fc8c4fbb-5ff8-4d40-8c7c-fe5f299672bf | |
| backupClientVersion | String | 备份客户端版本 | - | |
| backupClientStatus | String | 备份客户端状态 | Activated | |
| 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:本地 | 1 | |
| backupClientSubType | String | 网络类型 | 公网 | |
| osArch | String | 主机操作系统架构 | x86_64 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"backupClientList": [
{
"backupClientVersion": "v2.14.0",
"backupClientEnableInstall": false,
"instacneIps": [
"192.168.0.3"
],
"backupClientID": "6b738338-8f66-4d05-8601-d253db002d68",
"backupClientStatus": "Activated",
"osArch": "x86_64",
"osType": "linux",
"instacneID": "b3b1f09c-8c3c-43e0-7e93-65b044507494",
"imageName": "CentOS-7-9-adb-1-x86",
"backupClientSubType": "公网",
"backupClientUpdateNeed": false,
"backupClientType": 0,
"backupClientDesc": "已激活",
"instanceName": "ecm-73ca-xyy"
}
],
"backupClientTotal": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
