查询跨域备份列表v2
更新时间 2025-11-05 15:19:43
最近更新时间: 2025-11-05 15:19:43
接口功能介绍
查询文档数据库实例的跨域备份列表
接口约束
用户通过鉴权认证
URI
GET /DDS2/v2/openApi/queryCrossDomainBackupHistoryList
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 否 | String | 文档数据库对外的实例标识 | 60d420bffb394*** | |
| backupName | 否 | String | 备份名称 | bak001 | |
| startTime | 否 | String | 备份查询开始时间 | 2022-10-10 00:00:00 时间格式为：yyyy-MM-dd HH:mm:ss | |
| endTime | 否 | String | 备份查询结束时间 | 2022-10-10 00:00:00 时间格式为：yyyy-MM-dd HH:mm:ss | |
| pageNow | 否 | Integer | 当前页，不传默认为1 | 1 | |
| pageSize | 否 | Integer | 页大小，不传默认为10 | 10 | |
| targetRegionId | 否 | String | 跨域备份列表筛选目标资源池 | 81f7728662dd11ec810800155d307d5b |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 查询跨域备份列表成功 | |
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页数量 | 10 | |
| total | Integer | 查询总数 | 100 | |
| list | Object | 查询结果主体 | list | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupType | String | 备份类型 | 手动备份 | |
| startTime | String | 备份开始时间 | 1715409206000 | |
| errorCode | Integer | 结果:0代表没有开始，1代表参数不对，2代表执行过程中，3代表成功，4代表被停止，5代表执行失败 | 3 | |
| prodInstName | String | 实例名称 | dds-342-recovernewinstance | |
| datalen | String | 数据备份处理的数据量 | 373M | |
| storageType | String | 存储类型，对象存储或云硬盘存储 | 对象存储 | |
| prodInstId | String | 实例id | 60d420bffb394*** | |
| endTime | String | 备份结束时间 | 1715409216000 | |
| backupName | String | 备份名称 | autoBackup_20240511143326141 |
枚举参数
无
请求示例
请求url
/v2/openApi/queryCrossDomainBackupHistoryList?prodInstId=a290bde98727433c966ecd52b8e66b3f
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 800,
"message": "查询跨域备份列表成功",
"returnObj": {
"lastPage": 0,
"navigatepageNums": null,
"startRow": 0,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 0,
"pageSize": 1,
"list": [
{
"prodInstName": "dds-342-recovernewinstance",
"errorCode": 3,
"storageType": "对象存储",
"prodInstId": "60d420bffb394***",
"startTime": 1715409206000,
"endTime": 1715409216000,
"backupName": "autoBackup_20240511143326141",
"dataLen": "373M",
"backupType": "手动备份"
}
],
"pageNum": 1,
"navigatePages": 0,
"total": 32,
"pages": 0,
"firstPage": 0,
"size": 0,
"isLastPage": false,
"hasPreviousPage": false,
"isFirstPage": false
}
}
状态码
请参考 状态码
错误码
请参考 错误码
