文档首页/ 云空间服务 KooDrive/ API参考(运营商)/ API/ 备份范围/ 添加备份范围 - batchAddBackupScope
更新时间:2026-05-15 GMT+08:00

添加备份范围 - batchAddBackupScope

功能介绍

批量添加模块备份范围

授权信息

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

URI

POST /koodrive/ose/v1/backup/device/{deviceId}/scope

表1 路径参数

参数

是否必选

参数类型

描述

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

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

moduleCode

String

参数解释:

模块码

约束限制:

100-102

取值范围:

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

默认取值:

不涉及

scopeList

Array of ScopeBaseInfo objects

参数解释:

范围列表

约束限制:

最大长度100

取值范围:

不涉及

默认取值:

不涉及

表4 ScopeBaseInfo

参数

是否必选

参数类型

描述

localPath

String

参数解释:

本地路径,使用"/"做路径分隔符,必须以"/"开头,和targetFolderPath不可以同时为空

约束限制:

^(?:$|/[^\]*$)

取值范围:

最大长度10000

默认取值:

不涉及

targetFolderPath

String

参数解释:

云端目标文件夹,使用"/"做路径分隔符,必须以"/"开头,和localPath不可以同时为空

约束限制:

^(?:$|/[^\]*$)

取值范围:

最大长度10000

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

code

Integer

状态码

msg

String

状态描述

scopeList

Array of ScopeInfo objects

添加成功的范围信息

failedScopeList

Array of ScopeAddFailedInfo objects

添加失败的范围信息

表6 ScopeInfo

参数

参数类型

描述

localPath

String

本地路径

targetFolderPath

String

云端目标文件夹

scopeId

String

范围id

moduleCode

String

模块编码

createTime

String

创建时间

表7 ScopeAddFailedInfo

参数

参数类型

描述

localPath

String

本地路径

targetFolderPath

String

云端目标文件夹

errorCode

String

错误码

msg

String

错误信息

请求示例

批量添加模块备份范围请求示例

/koodrive/ose/v1/backup/device/1842812272691451648/scope

Authorization:Bearer+60f4ccc7b1********3dd9a68068
{
    "moduleCode": "102",
    "scopeList": [
        {
            "localPath": "/asdkhsdahjksd",
            "targetFolderPath": "/ashdjkha"
        }
    ]
}

响应示例

状态码:200

批量添加模块备份范围响应体

{
  "scopeList" : [ {
    "localPath" : "/asdkhsdahjksd",
    "targetFolderPath" : "/ashdjkha",
    "scopeId" : "1842846715527366528",
    "moduleCode" : "102",
    "createTime" : "2025-12-17T07:27:27.709Z"
  } ],
  "failedScopeList" : [ ],
  "code" : 0,
  "msg" : "success"
}

状态码

状态码

描述

200

批量添加模块备份范围响应体