发起租户恢复 | OceanBase 文档中心

发起租户恢复

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

功能说明

该接口用于将已备份的租户恢复到目标集群。

调用说明

接口约束

调用者需对恢复的目标集群有租户创建的权限。
调用者需要通过 OCP 应用服务鉴权。

请求路径

POST /api/v2/ob/clusters/{id}/backup/restore

请求参数

参数	类型	必选	示例值	描述
id	Integer	是	1001	已备份集群的 ID。

RestoreTenantParam的数据结构

参数	类型	必选	说明
backupTenantStatus	String	是	备份租户的状态，在线(ONLINE) 或者离线(OFFLINE)。
restoreOnlineTenantRequiredParam	Object	否	当备份租户是在线时，该参数为必选。
\|----backupClusterId	Long	是	备份集群 ID。
\|----backupTenantId	Long	是	备份租户 ID。
\|----restoreClusterId	Long	是	恢复集群 ID。
\|----restoreEndTime	OffsetDateTime	是	恢复到某个时刻。
\|----restoreTenantInfoParam	Object	是	恢复的目标租户模型。
\|----name	String	是	租户名。
\|----primaryZone	String	否	主可用区。
\|----zones	Arrays	是	Zone 配置。
\|----name	String	是	Zone 名。
\|----replicaType	String	是	副本类型，包括FULL,LOGONLY、READONLY。
\|----resourcePool	Object	是	资源池配置。
\|----unitSpecName	String	是	规格名。
\|----unitCount	Long	是	规格数目。
restoreOfflineTenantRequiredParam	Object		当备份租户是离线时，该参数为必选。
\|----backupMode	String	是	备份方式。
\|----backupClusterName	String	是	备份集群名。
\|----backupObClusterId	Long	否	备份集群 ID（OB 侧）。
\|----backupTenantName	String	是	备份租户名。
\|----backupObTenantId	Long	否	备份租户 ID (OB 侧)。
\|----restoreClusterId	Long	是	恢复集群 ID。
\|----obBackupStorageBaseInfo	Object	是	备份存储信息，参照创建集群的备份策略中的具体数据结构。
\|----restoreEndTime	OffsetDateTime	是	恢复到某个时刻。
\|----restoreTenantInfoParam	Object	是	恢复的目标租户模型，同在线恢复中的模型。

返回结果

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

BackupCommonResponse 的数据结构

参数	类型	说明
obBackupTaskType	String	备份操作类型，如："CREATE_BACKUP_STRATEGY"。
backupObjectOpsResultList	Array	备份对象操作结果集。
\|--obBackupObjectList	Array	备份对象列表。
\|--clusterId	Long	集群 ID。
\|--tenantId	Long	租户 ID。
\|--backupDimension	String	备份维度，如 CLUSTER，TENANT 分别代表集群备份，租户备份。目前暂不支持租户备份。
\|--beSuccessful	Boolean	操作是否成功。
\|--taskIdList	Array	任务编号列表，在有异步任务下返回。
\|--errorCode	Object	错误码。
\|--hint	String	提示信息。

示例

请求示例

{
    "backupTenantStatus": "ONLINE",
    "restoreOnlineTenantRequiredParam": {
        "restoreClusterId": 9,
        "restoreTenantInfoParam": {
            "name": "mysql_1",
            "zones": [
                {
                    "key": "30",
                    "name": "zone1",
                    "replicaType": "FULL",
                    "resourcePool": {
                        "unitSpecName": "S1",
                        "unitCount": 1
                    }
                }
            ],
            "primaryZone": "zone1"
        },
        "backupClusterId": 9,
        "backupTenantId": 21,
        "restoreEndTime": "2020-11-11T00:50:00.215+08:00"
    }
}

返回示例

{
    "data": {
        "backupObjectOpsResultList": [
            {
                "beSuccessful": true,
                "obBackupObjectList": [
                    {
                        "backupDimension": "CLUSTER",
                        "clusterId": 1000005
                    }
                ],
                "taskIdList": [
                    3000041
                ]
            }
        ],
        "obBackupTaskType": "RESTORE"
    },
    "duration": 51,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-07T14:51:41.135+08:00",
    "traceId": "5962f337662d4043"
}