查询备份客户端信息
更新时间 2023-10-12 15:22:33
最近更新时间: 2023-10-12 15:22:33
查询备份客户端信息API说明
接口介绍
查询一个或者多个备份客户端信息 ，根据用户输入的备份客户端ID，查询该备份客户端信息，如不指定备份客户端ID，则获取该用户该资源池下所有云主机的备份客户端信息列表
接口约束
无
URI
GET /v4/backup/info-client-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupClientID | 否 | String | 备份客户端ID,如不填写，则查询该用户该资源池下所有的备份客户端信息 | 参考请求示例 | |
| regionID | 是 | String | 资源池ID。 | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为处理中/失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码。 | 参考状态码 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| backupClientList | 是 | Array of Objects | 列表 | 参考表backupClientList | |
| backupClientTotal | 是 | Integer | 总数 | 参考响应示例 |
表 backupClientList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| instacneID | 是 | String | 云主机ID | 参考响应示例 | |
| instanceName | 是 | String | 云主机名称 | 参考响应示例 | |
| backupClientID | 是 | String | 备份客户端ID | 参考响应示例 | |
| backupClientVersion | 是 | String | 备份客户端版本 | 参考响应示例 | |
| backupClientStatus | 是 | String | 备份客户端状态 | 参考状态枚举表 |
请求示例
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"returnObj": {
"backupClientList": [
{
"instacneID": "82e2defb-3bc8-aa3f-99c7-ccb0aba0fcb0",
"instanceName": "ecm-41a8",
"backupClientID": "4a886099-2586-4d8d-ac16-ae53778ee9ad",
"backupClientVersion": "V1.0",
"backupClientStatus": "Activated"
}
],
"backupClientTotal": 1
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
错误码
请参考状态码
