查询集群的备份概览 | OceanBase 文档中心

查询集群的备份概览

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

功能说明

该接口用于查询集群的备份概览，包括集群的基本信息，最近一次数据备份时间，日志备份位点，日志延迟时间，以及备份大小等信息。

调用说明

接口约束

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

请求路径

GET /api/v2/ob/clusters/{id}/backup/overview

请求参数

参数	类型	必选	示例值	描述
id	Integer	是	1001	需查询备份概览的集群 ID。

返回结果

参数	类型	说明
data	Object	备份概览。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
server	String	响应请求的应用服务的地址。

ClusterBackupInfoDetail 的数据结构

参数	类型	说明
clusterId	Long	集群 ID。
obClusterId	Long	OB 集群 ID。
clusterName	String	集群名
obTenantId	Long	OB 侧租户 ID。
tenantId	Long	租户 ID
tenantName	String	租户名
obClusterType	String	集群类型，包括 PRIMARY 和 STANDBY。
obClusterStatus	String	集群状态
compactionStatus	String	集群合并状态
primaryAndStandbyMode	Boolean	是否主备模式
obVersion	String	OB 版本
obClusterBackupStatus	String	备份状态，包括HAS_BACKUP_STRATEGY、NO_BACKUP_STRATEGY。
obBackupAbility	Object	备份能力。
\|----backupAbility	String	备份能力，包括 LOGICAL_BACKUP、PHYSICAL_BACKUP、LOGICAL_AND_PHYSICAL。
\|----backupMode	String	备份方式，包括 LOGICAL_BACKUP、PHYSICAL_BACKUP。
backupDimension	String	备份维度，包括 CLUSTER 和 TENANT。
backupScheduleStatus	String	备份调度状态，包括 NONE、NORMAL、PAUSED、WAITING、ABNORMAL。
lastDataBackupTime	Timestamp	最近的数据备份时间。
latestLogBackupCheckpoint	Timestamp	最新的日志备份位点。
logBackupDelaySeconds	Long	日志备份延迟时间，单位为秒。
backupSize	Double	备份大小。
obStorageVolumeUnit	String	备份单位，包括 B、KB、MB、GB、TB、PB。

示例

请求示例

查询集群 ID 为 1 的备份概览。

GET /api/v2/ob/clusters/1/backup/overview

返回示例

{
    "data": {
        "backupDimension": "CLUSTER",
        "backupScheduleStatus": "NORMAL",
        "clusterId": 1000005,
        "clusterName": "yc0820_17",
        "compactionStatus": "IDLE",
        "lastDataBackupTime": "2021-09-16T17:25:02.993+0800",
        "latestLogBackupCheckpoint": "2021-09-22T14:49:07.296+0800",
        "logBackupDelaySeconds": 98,
        "obBackupAbility": {
            "backupAbility": "PHYSICAL_BACKUP",
            "backupMode": "PHYSICAL_BACKUP",
            "obDataBackupSupportAbility": {
                "canDoIncrementalBackup": false,
                "fullBackupEnabled": true,
                "hint": "物理备份下，增量备份之前必须有一次全量的数据备份",
                "incrementBackupEnabled": true
            }
        },
        "obClusterBackupStatus": "HAS_BACKUP_STRATEGY",
        "obClusterId": 5,
        "obClusterStatus": "RUNNING",
        "obClusterType": "PRIMARY",
        "obVersion": "2.2.77",
        "primaryAndStandbyMode": false
    },
    "duration": 324,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-22T14:50:46.414+08:00",
    "traceId": "52eddd79029d4a24"
}