---
title: "查询集群的备份能力 | OceanBase 文档中心"
description: "查询集群的备份能力 功能说明 该接口用于查询 OceanBase 集群的备份能力，即是否可备份、支持的备份方式等。 调用说明 接口约束 调用者需具备对该集群的备份恢复只读权限。 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/ob/clusters/{id}/backup/ability 请…"
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.0.3 企业版

# 查询集群的备份能力

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

## 功能说明

该接口用于查询 OceanBase 集群的备份能力，即是否可备份、支持的备份方式等。

## 调用说明

### 接口约束

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

### 请求路径

`GET /api/v2/ob/clusters/{id}/backup/ability`

### 请求参数

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

### 返回结果

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

**ObBackupAbility 的数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| backupAbility | String | 备份支持能力，包括： * LOGICAL_BACKUP * PHYSICAL_BACKUP * LOGICAL_AND_PHYSICAL |
| backupMode | String | 备份方式，包括： * LOGICAL_BACKUP * PHYSICAL_BACKUP |
| obDataBackupSupportAbility | Object | OB 数据备份的支持能力，主要包括下述的 3 个能力。 |
| \|--fullBackupEnabled | Boolean | 集群是否支持全量备份。 |
| \|--incrementBackupEnabled | Boolean | 集群是否支持增量备份。 |
| \|--canDoIncrementalBackup | Boolean | 集群当前是否可以增量备份。 |
| \|--hint | String | 提示信息。 |
| obBackupCondition | Object | 备份恢复所需的条件，包含下述的 3 个条件。 |
| \|--needAgentToBackup | Boolean | 备份是否需要组件。 |
| \|--needAgentToRestore | Boolean | 恢复是否需要组件。 |
| \|--agentMetaDbSchema | String | 备份组件的元数据库名。 |
| obRestoreConditionCheckResult | Object | 恢复所需条件的检查结果，包含下述单元格中内容。 |
| \|--backupTaskType | String | 备份任务的类型。 |
| \|--beReady | Boolean | 是否可以备份。 |
| \|--needDependentOnAgents | String | 备份是否需要依赖组件。 |
| \|--serviceNameList | List<String> | 备份在依赖组件时对应的备份恢复服务名。 |
| \|--agentMetaDbSchema | String | 元数据库 Schema。 |
| \|--errorCodes | String | 错误码。 |
| \|--hint | String | 提示信息。 |

## 示例

### 请求示例

查询某个集群的备份恢复能力

### 返回示例

```unknow
{
    "data": {
        "backupAbility": "PHYSICAL_BACKUP",
        "backupMode": "PHYSICAL_BACKUP",
        "obDataBackupSupportAbility": {
            "canDoIncrementalBackup": false,
            "fullBackupEnabled": true,
            "hint": "物理备份下，增量备份之前必须有一次全量的数据备份",
            "incrementBackupEnabled": true
        }
    },
    "duration": 22,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-23T15:31:29.276+08:00",
    "traceId": "45d27e7dc09b4ca9"
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线