接口功能介绍
调用describeBackups接口查询实例备份列表。
接口约束
无
URI
GET /v1/openApi/describeBackups
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| prodInstId | 非必填 | String | 文档数据库对外的实例标识 | a649077e15f349cb8b4cde6f7285a568 |
| prodInstFlag | 非必填 | String | 数据库的标签 规定为“实例ID 实例名称 | a649077e15f349cb8b4cde6f7285a568 test001 |
| backupName | 非必填 | String | 备份名称 | bak001 |
| startTime | 非必填 | String | 备份查询开始时间 | 2022-10-10 00:00:00 |
| endTime | 非必填 | String | 备份查询结束时间 | 2022-10-10 00:00:00 |
| pageNow | 非必填 | Integer | 当前页 | 1 |
| pageSize | 非必填 | Integer | 页大小 | 10 |
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询XXX信息成功 | |
| returnObj | 是 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNum | 是 | Integer | 当前页 | 1 | |
| pageSize | 是 | Integer | 每页数量 | 10 | |
| total | 是 | Integer | 查询总数 | 100 | |
| list | 是 | object[] | 查询结果主体 | list |
表list
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodOrderStatus | 是 | Integer | 订单状态: 0->订单正常, 1->订单冻结, 2->订单注销, 3->施工中, 4->施工失败 | ||
| storePassword | 是 | String | 存放备份数据机器的密码 | 123456 | |
| prodInstFlag | 是 | String | dds数据库的标签 规定为“实例ID 实例名称” | a649077e15f349cb8b4cde6f7285a568 test001 | |
| prodDbEngine | 是 | String | dds数据库产品的版本 | 4.0 | |
| description | 是 | String | 描述信息 | ||
| ymdhi | 是 | String | 废弃字段 | 1 | |
| backupType | 是 | String | 备份类型：自动备份，手动备份 | 自动备份 | |
| result | 是 | String | 对操作结果的简单描述 | ||
| storeUser | 是 | String | 存放备份数据的用户名 | admin | |
| parameterGroupUsed | 是 | String | shard、单点或者副本集参数组名称，可从参数组名称中看出参数组版本 | ||
| host | 是 | String | 备份数据的来源机器 | 127.0.0.1 | |
| prodInstSetName | 是 | String | dds数据库实例对应的SET名 | set_mm_1 | |
| storeIp | 是 | String | 备份文件存放的主机IP | 127.0.07 | |
| startTime | 是 | String | 备份开始时间 | 2022-10-10 00:00:00 | |
| toLsn | 是 | String | 备份返回的最新lsn，废弃字段 | ||
| id | 是 | Integer | 备份表的主键id | 1 | |
| binlogEndTime | 是 | String | 废弃字段 | ||
| errorcode | 是 | Integer | 结果:0代表没有开始，1代表参数不对，2代表执行过程中，3代表成功，4代表被停止，5代表执行失败 | 0 | |
| sshPort | 是 | String | 备份机器登录端口 | 8888 | |
| prodInstName | 是 | String | 实例名称 | test001 | |
| binlogPosition | 是 | String | 备份返回的binlog文件的位置，废弃字段 | ||
| dbType | 是 | String | 数据库类型，废弃字段 | ||
| history | 是 | String | 对操作结果的详细描述 | ||
| prodType | 是 | Integer | 实例类型0: 单实例, 1:一主一从, 2:一主两从, 3:一主三从 | 0 | |
| datalen | 是 | String | 数据备份处理的数据量 | --- | |
| 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 | |
| prodInstId | 是 | String | 实例id | a649077e15f349cb8b4cde6f7285a568 | |
| endTime | 是 | String | 备份结束时间 | 2022-10-10 00:00:00 | |
| backupName | 是 | String | 备份名称 | bak001 |
请求示例
请求头header
无
请求参数query
/v1/openApi/describeBackups?prodInstId=a649077e15f349cb8b4cde6f7285a568
响应示例
{
"statusCode": 800,
"message": "Success",
"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,
"errorcode": 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,
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"endTime": 1658914910000,
"backupName": "test-0727"
}
],
"pageNum": 1,
"total": 2
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
