获取备份任务信息
更新时间 2025-09-26 14:46:15
最近更新时间: 2025-09-26 14:46:15
接口功能介绍
调用接口获取备份任务信息
接口约束
无
URI
GET /RDS2/v2/open-api/backup/get
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | Integer | 备份记录id，与查询备份列表里backupRecordId一致 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| inst-id | 否 | String | 实例id （和参数outerProdInstId保持一致） | 264729201196525109 | |
| regionId | 是 | String | 资源池regionId，比如实例在资源池A，则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 | 0 | |
| message | String | 返回消息 | ||
| returnObj | Object | 返回结果 | BackupRecord | |
| 表 BackupRecord |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupRecordId | Long | 备份记录id | 1 | |
| backupTaskId | Long | 备份任务id | 123 | |
| taskId | String | 任务id | 1698163340-10281 | |
| backupName | String | 备份名称 | mysql-618-231115000635 | |
| prodInstId | Integer | 实例id | 10281 | |
| outerProdInstId | String | 外部实例id | b6a094853c21d5aac0a1 | |
| prodInstName | String | 实例名称 | mysql-618 | |
| description | String | 备份描述 | sdasd | |
| storageType | String | 存储类型； 对象存储： s3 本地存储：disk 跨区域备份：region_s3 | s3 | |
| opType | String | 操作类型 自动备份: auto 手工备份: manual | auto | |
| taskType | String | 备份类型，取值 全量备份：full, 增量备份：incr | full | |
| taskStatus | Integer | 等待开始：100; 已提交：101; 已取消：102; 成功: 1； 失败: -1; 备份中：其他值 | 100 | |
| backedUpDataSize | String | 备份大小: bytes（字节） | 1024 | |
| backedUpDataSizeHuman | String | 展示大小；单位自动适配 | 1KB | |
| backupStartTime | String | 备份开始时间 | 2023-02-13 00:00:00 | |
| backupEndTime | String | 备份结束时间 | 2023-02-13 00:00:00 | |
| disabled | Boolean | 禁用备份 | true |
枚举参数
无
请求示例
请求url
/RDS2/v2/open-api/backup/get?id=1
请求头header
无
请求体body
无
响应示例
{"statusCode":0,"message":"success","returnObj": {"backupRecordId": 16,"backupTaskId": 14,"taskId": "1698163340-10281","prodInstId": 10281,"outerProdInstId": "b6a094853c21d5aac0a1","prodInstName": "mysql-618","backupName": "mysql-618-231115000635","description": "aut000105","storageType": "disk","opType": "auto","taskType": "full","taskStatus": 1,"backedUpDataSize": 1094944,"backedUpDataSizeHuman": "1.04 MB","backupStartTime": "2023-10-25 00:00:23","backupEndTime": "2023-10-25 00:02:53","prodInstName": "mysql-618","disabled": false}}
状态码
请参考 状态码
错误码
请参考 错误码
