查询某一集群的日志备份任务

更新时间：2023-08-10 11:45:58

功能说明

该接口用于查询某一 OceanBase 集群的日志备份任务。

调用说明

接口约束

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

请求路径

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

请求参数

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

返回结果

参数	类型	说明
data	Object	请求的数据。
├─ contents	Array	LogBackupWrapperTask 的数组，详细数据结构见 LogBackupWrapperTask 的数据结构。
├─ 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	响应请求的应用服务的地址。

LogBackupWrapperTask 的数据结构

参数	类型	说明
createTime	Timestamp	创建时间。
modifyTime	Timestamp	修改时间。
clusterName	String	集群名。
clusterId	Long	集群 ID。
obClusterId	Long	OB 集群 ID。
obTenantId	Long	OB 侧租户 ID。
clusterType	String	集群类型，包括 PRIMARY、STANDBY。
tenantId	Long	租户 ID。
tenantName	String	租户名。
status	String	状态。
errorMsg	String	错误信息。
backupUri	String	备份路径。
checkpoint	Timestamp	最新位点。
backupMode	String	备份模式。
delay	Long	日志延迟，单位为秒。

示例

请求示例

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

返回示例

{
    "data": {
        "contents": [
            {
                "agentServerIp": "xxx.xxx.xxx.xxx",
                "backupMode": "PHYSICAL_BACKUP",
                "backupUri": "file:///obbackup/",
                "checkpoint": "2021-09-23T14:33:17.357+0800",
                "clusterId": 1000005,
                "clusterName": "yc0820_17",
                "clusterType": "PRIMARY",
                "createTime": "2021-09-09T16:19:47.405+0800",
                "delay": 77.6421,
                "obClusterId": 5,
                "status": "RUNNING"
            }
        ],
        "page": {
            "number": 1,
            "size": 1,
            "totalElements": 1,
            "totalPages": 1
        }
    },
    "duration": 112,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-23T14:34:35.149+08:00",
    "traceId": "0e74add7846c479c"
}