更新时间:2026-02-03 GMT+08:00

列举备份记录 - listBackupRecord

功能介绍

列举备份记录

授权信息

当前API调用无需身份策略权限。

URI

GET /koodrive/ose/v1/backup/record

表1 Query参数

参数

是否必选

参数类型

描述

moduleCode

String

参数解释:

模块码

约束限制:

100-102

取值范围:

100 文件夹备份,101 相册备份,102 通讯录备份

默认取值:

不涉及

pageSize

Integer

参数解释:

每页大小

约束限制:

不涉及

取值范围:

1-100

默认取值:

不涉及

cursor

String

参数解释:

下页游标

约束限制:

不涉及

取值范围:

长度最大为1000

默认取值:

不涉及

deviceId

String

参数解释:

设备id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

该字段存储的是 Access Token。

调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。

约束限制:

格式参考:Bearer+/access token}

取值范围:

Access Token的获取请参考对应的开发手册

默认取值:

不涉及

X-User-Id

String

参数解释:

koodrive侧用户id,用于appId鉴权

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

X-Date

String

参数解释:

签名时间,用于appId鉴权

约束限制:

距当前时间15分钟以内,不能晚于当前时间

取值范围:

yyyMMdd'T'HHmmss'Z',例:20251103T070140Z

默认取值:

不涉及

参数解释:

签名时间,用于appId鉴权

约束限制:

距当前时间15分钟以内,不能晚于当前时间

取值范围:

yyyMMdd'T'HHmmss'Z',例:20251103T070140Z

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

code

Integer

状态码

msg

String

状态描述

data

Array of BackupRecord objects

备份记录列表

nextCursor

String

下页游标

表4 BackupRecord

参数

参数类型

描述

recordId

String

记录id

moduleCode

String

模块码

status

Integer

状态值:

  • 0:新建状态;

  • 1:完成状态;

  • 2:待删除状态;

properties

String

自定义属性

version

Integer

版本

createTime

String

创建时间

endTime

String

结束时间

deviceInfo

DeviceEntity object

设备信息

表5 DeviceEntity

参数

参数类型

描述

deviceId

String

设备id

machineCode

String

机器码

deviceName

String

设备名

deviceOS

String

设备系统

createTime

String

创建时间

请求示例

列举备份记录请求示例

/koodrive/ose/v1/backup/record?moduleCode=101&pageSize=100&deviceId=1842812272691451648

Authorization:Bearer+60f4ccc7b1********3dd9a68068
x-backup-lock-id: 78e41c7e-db02-4d55-85b3-8153e4fefd2e@102

响应示例

状态码:200

列举备份记录响应体

{
  "data" : [ {
    "recordId" : "1842862763295184641",
    "moduleCode" : "101",
    "status" : 1,
    "properties" : "{\"test\":\"123\"}",
    "version" : 1,
    "createTime" : "2025-12-17T07:59:20.752Z",
    "endTime" : "2025-12-17T08:29:00.437Z"
  } ],
  "code" : 0,
  "msg" : "success"
}

状态码

状态码

描述

200

列举备份记录响应体