查询实例备份列表
更新时间 2026-02-13 17:51:36
最近更新时间: 2026-02-13 17:51:36
接口功能介绍
查询文档数据库实例备份列表
接口约束
用户通过鉴权认证
URI
GET /DDS2/v1/openApi/describeBackups
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | 60d420bffb394************************* | |
| prodInstFlag | 否 | String | 数据库的标签 规定为“实例ID 实例名称 | 60d420bffb394************************* test001 | |
| 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 | |
| pageSize | 否 | Integer | 页大小 | 10 | |
| backupType | 否 | String | 备份类型 | 自动备份 手动备份 | |
| isCrossDomain | 否 | String | 查询跨域备份 | 传参 1表示查询跨域备份 | |
| isSubscribe | 否 | String | 查询已退订实例备份列表 | 传参1 表示查询已退订实例备份列表 | |
| targetRegionId | 否 | String | 查询跨域备份目标资源池 | 81f7728662dd11ec810800155d307d5b ，传该参数时，isCrossDomain参数需要传参 1 | |
| errorCode | 否 | Byte | 查询备份结果 | 3表示成功，5表示失败 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 查询MongoDB实例的备份列表成功 | |
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页数量 | 10 | |
| total | Integer | 查询总数 | 100 | |
| list | Object | 查询结果主体 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| fromLsn | String | 备份开始的lsn，废弃字段 | ||
| gtidLastChange | String | 废弃字段 | ||
| storePath | String | 备份文件存放的主目录 | /data/test | |
| binlogFileName | String | 备份返回的binlog文件名，废弃字段 | ||
| backupDirName | String | 备份文件存放的子目录，废弃字段 | ||
| ctype | String | 任务上报类型，废弃字段 | ||
| createTime | String | 创建或修改时间 | 2022-10-10 00:00:00 | |
| port | String | 操作返回的数据库端口 | 8888 | |
| storageSize | Long | 备份文件字节大小 | 106259967 | |
| storageType | String | 存储类型，对象存储或云硬盘存储 | 对象存储 | |
| prodInstId | String | 实例id | 60d420bffb394************************* | |
| endTime | String | 备份结束时间 | 2022-10-10 00:00:00 | |
| backupName | String | 备份名称 | bak001 |
枚举参数
无
请求示例
请求url
/v1/openApi/describeBackups?prodInstId=60d420bffb394*************************
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 800,
"message": "查询MongoDB实例的备份列表成功",
"returnObj": {
"pageSize": 10,
"list": [
{
"prodOrderStatus": null,
"storePassword": null,
"prodInstFlag": "c46d8f547cc648a78a68270092e70f80 mongodb001",
"prodDbEngine": "4.0",
"description": null,
"ymdhi": null,
"backupType": "手动备份",
"result": null,
"storeUser": null,
"parameterGroupUsed": "Default-Mongo-4.0",
"host": null,
"prodInstSetName": "set_1098350",
"storeIp": null,
"startTime": 1658914910000,
"toLsn": null,
"id": 2,
"binlogEndTime": null,
"error": 5,
"sshPort": null,
"prodInstName": "mongodb001",
"binlogPosition": null,
"dbType": null,
"history": null,
"prodType": 0,
"datalen": "---",
"fromLsn": null,
"gtidLastChange": null,
"storePath": null,
"binlogFileName": null,
"backupDirName": null,
"ctype": null,
"createTime": 1658914911000,
"port": null,
"storageSize":106259967,
"storageType":"对象存储",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"endTime": 1658914910000,
"backupName": "test-0727"
}
],
"pageNum": 1,
"total": 2
}
}
状态码
请参考 状态码
错误码
请参考 错误码
