创建同步目录 - createSyncDir
功能介绍
创建同步目录
授权信息
当前API调用无需身份策略权限。
URI
POST /koodrive/ose/v1/syncDir/create
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Authorization |
是 |
String |
该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} |
|
X-User-Id |
是 |
String |
用户id，用于app鉴权 |
|
X-Date |
是 |
String |
日期，用于app鉴权 |
|
Host |
是 |
String |
地址，用于app鉴权 |
|
X-Traceid |
否 |
String |
消息日志跟踪标识（必须58位） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
container |
是 |
String |
空间ID |
|
fileName |
否 |
String |
同步目录名称 注：当传入一个名称时，系统会首先检查根目录（root）下是否存在同名的目录。如果存在同名目录，系统会创建一个带有时间后缀的新目录，并将其设置为同步目录。如果根目录下没有同名目录，系统将使用提供的文件名在根目录下创建一个新的同步目录；与fileId互斥，传了fileId时非必填，否则必填 |
|
hidden |
否 |
Boolean |
是否隐藏 缺省默认为false |
|
parentFolder |
否 |
String |
父目录ID 不支持传入根目录（root、sbox），如果不传则默认在根目录（root）创建 注：与fileId互斥 |
|
fileId |
否 |
String |
需要设置为同步目录的目录ID 传入后会将该目录设置为同步目录；与fileName、hidden、parentFolder互斥 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
container |
String |
空间ID |
|
fileId |
String |
文件ID |
|
fileName |
String |
同步目录名称 |
|
exist |
Boolean |
同步目录是否已存在 仅当同步目录已存在时返回 |
请求示例
创建同步目录请求示例
POST /koodrive/ose/v1/syncDir/create
Authorization:Bearer+10f88*********4791e9ff
{
"container": "K*****",
"fileName": "K*****",
"parentFolder": "K*****",
"fileId": "K*****",
"hidden": true
}
响应示例
状态码：200
创建与关联同步目录响应
{
"container" : "K*****",
"fileName" : "K*****",
"fileId" : "K*****",
"exist" : true
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
创建与关联同步目录响应 |
