查询指定集群的备份策略 | OceanBase 文档中心

查询指定集群的备份策略

更新时间：2023-08-16 15:51:32

功能说明

该接口用于查询 OceanBase 集群的备份策略详情。

调用说明

接口约束

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

请求路径

GET /api/v2/ob/clusters/{id}/backup/config/backupStrategy

请求参数

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

返回结果

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

OcpBackupStrategy 的数据结构

参数	类型	说明
id	Long	策略 ID。
createTime	Date	创建时间。
updateTime	Date	更新时间。
clusterName	String	集群名。
obClusterId	Long	OB 集群 ID。
clusterId	Long	集群 ID。
backupDimension	String	备份维度，包括 CLUSTER，TENANT。目前仅支持集群级备份。
tenantName	String	租户名。
obTenantId	Long	租户 ID，OB 侧 ID。
tenantId	Long	租户 ID，OCP 侧 ID。
type	String	备份目的类型，包括 BACKUP、SECONDARY_BACKUP 。
obBackupServiceStorageConfig	Object	备份存储配置，参见创建集群的备份策略中的 ObBackupServiceStorageConfig 的数据结构。
backupMode	String	备份恢复方式，支持 LOGICAL_BACKUP、 PHYSICAL_BACKUP 两种。
serviceConfigName	String	服务配置名。
obBackupScheduleConfig	Object	备份调度配置，参见创建集群的备份策略中的 obBackupScheduleConfig 的数据结构。

示例

请求示例

查询 ID 为 1 的 OceanBase 集群的备份策略。

GET /api/v2/ob/clusters/1/backup/config/backupStrategy

返回示例

{
    "data":{
        "contents":[
            {
                "alarmSummaries":[
                    {
                        "count":0,
                        "level":1,
                        "linkDataUrl":"http://xxx.xxx.xxx.xxx:8080/api/v2/alarm/alarms?isSubscribedByMe=false&page=1&size=10&level=1&category=OB&status=Active&obCluster=test",
                        "linkUrl":"http://xxx.xxx.xxx.xxx:8080/alarm/event?isSubscribedByMe=false&page=1&size=10&level=1&category=OB&status=Active&obCluster=test"
                    },
                    {
                        "count":0,
                        "level":2,
                        "linkDataUrl":"http://xxx.xxx.xxx.xxx:8080/api/v2/alarm/alarms?isSubscribedByMe=false&page=1&size=10&level=2&category=OB&status=Active&obCluster=test",
                        "linkUrl":"http://xxx.xxx.xxx.xxx:8080/alarm/event?isSubscribedByMe=false&page=1&size=10&level=2&category=OB&status=Active&obCluster=test"
                    },
                    {
                        "count":0,
                        "level":3,
                        "linkDataUrl":"http://xxx.xxx.xxx.xxx:8080/api/v2/alarm/alarms?isSubscribedByMe=false&page=1&size=10&level=3&category=OB&status=Active&obCluster=test",
                        "linkUrl":"http://xxx.xxx.xxx.xxx:8080/alarm/event?isSubscribedByMe=false&page=1&size=10&level=3&category=OB&status=Active&obCluster=test"
                    },
                    {
                        "count":0,
                        "level":4,
                        "linkDataUrl":"http://xxx.xxx.xxx.xxx:8080/api/v2/alarm/alarms?isSubscribedByMe=false&page=1&size=10&level=4&category=OB&status=Active&obCluster=test",
                        "linkUrl":"http://xxx.xxx.xxx.xxx:8080/alarm/event?isSubscribedByMe=false&page=1&size=10&level=4&category=OB&status=Active&obCluster=test"
                    },
                    {
                        "count":0,
                        "level":5,
                        "linkDataUrl":"http://xxx.xxx.xxx.xxx:8080/api/v2/alarm/alarms?isSubscribedByMe=false&page=1&size=10&level=5&category=OB&status=Active&obCluster=test",
                        "linkUrl":"http://xxx.xxx.xxx.xxx:8080/alarm/event?isSubscribedByMe=false&page=1&size=10&level=5&category=OB&status=Active&obCluster=test"
                    }
                ],
                "createTime":"2020-11-29T22:23:12+08:00",
                "creator":"admin",
                "id":1000002,
                "name":"test",
                "obClusterId":4,
                "obVersion":"2.2.73",
                "regionCount":1,
                "rootServers":[
                    {
                        "address":"xxx.xxx.xxx.xxx:2882",
                        "role":"LEADER",
                        "sql_port":2881
                    }
                ],
                "serverCount":1,
                "standbyClusters":[

                ],
                "status":"RUNNING",
                "tenantCount":0,
                "type":"PRIMARY",
                "zones":[
                    {
                        "idcId":1,
                        "idcName":"hz",
                        "innerStatus":"ACTIVE",
                        "name":"zone1",
                        "operateStatus":"NORMAL",
                        "regionName":"hz",
                        "serverCount":1,
                        "servers":[

                        ],
                        "status":"RUNNING"
                    }
                ]
            }
        ],
        "page":{
            "number":1,
            "size":10,
            "totalElements":1,
            "totalPages":1
        }
    },
    "duration":108,
    "server": "a83ad33525",
    "status":200,
    "successful":true,
    "timestamp":"2020-12-02T20:03:58.233+08:00",
    "traceId":"3cfec9a5180748ff"
}