针对某个集群进行立即备份

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

功能说明

该接口用于对某个集群发起一次立即备份。

调用说明

接口约束

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

请求路径

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

path:

参数	类型	必选	示例值	描述
id	Integer	是	1	需发起立即备份的集群 ID。

请求参数

参数	类型	必选	示例值	描述
obBackupObject	Object	否	NA	备份对象，会自动填充。
backupMode	String	是	LOGICAL_BACKUP	备份模式。取值范围： * LOGICAL_BACKUP：逻辑备份 * PHYSICAL_BACKUP：物理备份
dataBackupMode	String	是	FULL_BACKUP	数据备份模式，包括 FULL_BACKUP、 INCREMENTAL_BACKUP
obBackupServiceStorageConfig	Object	是	NA	备份存储配置，参见创建集群的备份策略中的具体数据结构。

返回结果

参数	类型	说明
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	提示信息。

示例

请求示例

{
    "obBackupObject": {
        "clusterId": 8,
        "backupDimension": "CLUSTER"
    },
    "dataBackupMode": "FULL_BACKUP",
    "obBackupServiceStorageConfig": {
        "alarmStoragePercentageThreshold": 95,
        "configName": "ycnfs223_0915",
        "obBackupStorageBaseInfo": {
            "backupStorageType": "BACKUP_STORAGE_FILE",
            "storageUrl": "/obbackup/"
        },
        "serviceName": "ycfor223",
        "storageId": 26
    }
}

返回示例

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