查询某一集群的数据备份任务

更新时间：2023-11-21 09:58:00

编辑

功能说明

该接口用于查询指定集群的数据备份任务。

调用说明

接口约束

调用者需至少具备对该集群备份恢复的只读权限。
调用者需要通过 OCP 应用服务鉴权。

请求路径

GET /api/v2/ob/clusters/{id}/backup/task/dataBackupTasks

请求参数

参数	类型	必选	示例值	描述
id	Long	是	1	集群 ID。
startTime	OffsetDateTime	否	2021-09-16T15:14:51.397+08:00	时间范围的开始时间。
endTime	OffsetDateTime	否	2021-09-16T15:20:51.397+08:00	时间范围的结束时间。
backupSetId	Long	否	23	数据备份集 ID。
page	Long	是	1	分页数，即查询第几页的内容。
size	Long	是	10	每页显示内容条数。

返回结果

参数	类型	说明
data	Object	请求的数据。
├─ contents	Array	DataBackupHistoryWrapperTask 的数组，详细数据结构见 DataBackupHistoryWrapperTask 的数据结构。
├─ page	Object	分页信息。
├─ totalElements	Integer	总记录数。
├─ totalPage	Integer	总页数。
├─ number	Integer	当前页码。
├─ size	Integer	当前页大小。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
server	String	响应请求的应用服务的地址。

DataBackupHistoryWrapperTask 的数据结构

参数	类型	说明
taskId	Long	任务 ID。
backupType	String	备份类型。
taskType	String	任务类型。
clusterName	String	集群名。
clusterId	Long	集群 ID。
obClusterId	Long	OceanBase 集群 ID。
obTenantId	Long	OceanBase 侧租户 ID。
clusterType	String	集群类型，包括 PRIMARY、STANDBY。
tenantId	Long	租户 ID。
tenantName	String	租户名。
startTime	Timestamp	开始时间。
finishTime	Timestamp	结束时间。
status	String	状态。
errorMsg	String	错误信息。
dataVersion	Long	数据版本号。
backupUri	String	备份路径。
dataType	String	数据类型。
schemaVersion	Long	Schema 版本号。
backupSetId	Long	数据备份集 ID.
backupMode	String	备份模式.
dataBackupTaskType	String	数据备份任务类型。
dataSecondaryBackupTaskIds	Arrays	基于该数据备份集 ID，做过的二次备份任务 ID列表，在物理备份下，该字段才有意义。

示例

请求示例

GET api/v2/ob/clusters/1000005/backup/task/dataBackupTasks?page=1&size=10

返回示例

{
    "data": {
        "contents": [
            {
                "backupMode": "PHYSICAL_BACKUP",
                "backupSetId": 23,
                "backupUri": "file:///obbackup/",
                "clusterId": 1000005,
                "clusterName": "yc0820_17",
                "clusterType": "PRIMARY",
                "dataBackupTaskType": "FULL_BACKUP",
                "dataSecondaryBackupTaskIds": [
                    14
                ],
                "dataVersion": 32,
                "finishTime": "2021-09-16T17:25:05.943+0800",
                "obClusterId": 5,
                "startTime": "2021-09-16T17:25:02.993+0800",
                "status": "DONE",
                "taskId": 23,
                "tenantId": 0
            },
            {
                "backupMode": "PHYSICAL_BACKUP",
                "backupSetId": 22,
                "backupUri": "file:///obbackup/",
                "clusterId": 1000005,
                "clusterName": "yc0820_17",
                "clusterType": "PRIMARY",
                "dataBackupTaskType": "FULL_BACKUP",
                "dataSecondaryBackupTaskIds": [
                    12
                ],
                "dataVersion": 31,
                "finishTime": "2021-09-15T17:25:06.269+0800",
                "obClusterId": 5,
                "startTime": "2021-09-15T17:25:03.498+0800",
                "status": "DONE",
                "taskId": 22,
                "tenantId": 0
            },
            {
                "backupMode": "PHYSICAL_BACKUP",
                "backupSetId": 21,
                "backupUri": "file:///obbackup/",
                "clusterId": 1000005,
                "clusterName": "yc0820_17",
                "clusterType": "PRIMARY",
                "dataBackupTaskType": "FULL_BACKUP",
                "dataSecondaryBackupTaskIds": [
                    10
                ],
                "dataVersion": 29,
                "finishTime": "2021-09-13T17:25:08.473+0800",
                "obClusterId": 5,
                "startTime": "2021-09-13T17:25:05.687+0800",
                "status": "DONE",
                "taskId": 21,
                "tenantId": 0
            }
        ],
        "page": {
            "number": 1,
            "size": 2000,
            "totalElements": 3,
            "totalPages": 1
        }
    },
    "duration": 84,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-23T11:03:24.945+08:00",
    "traceId": "975e0a8a452e4ab7"
}