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

创建分享 - createShare

功能介绍

创建分享。

授权信息

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

URI

POST /koodrive/ose/v1/share

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token}

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

X-Traceid

String

参数解释:

业务跟踪id(必须58位)

约束限制:

不涉及

取值范围:

长度为58位

默认值:

不涉及

X-User-Id

String

参数解释:

KooDrive侧用户id,用于app鉴权

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

X-Date

String

参数解释:

日期,用于app鉴权,格式为yyyyMMdd‘T’HHmmss‘Z’

约束限制:

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

取值范围:

不涉及

默认值:

不涉及

X-Hw-Agentname

String

参数解释:

运营商名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

表2 请求Body参数

参数

是否必选

参数类型

描述

scope

Integer

参数解释:

分享范围

约束限制:

不涉及

取值范围:

1:外链分享

3:指定企业用户访问

默认取值:

不涉及

fileIds

Array of strings

参数解释:

文件id列表

约束限制:

列表长度[1,100]

取值范围:

不涉及

默认取值:

不涉及

containerId

String

参数解释:

空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

extractCode

String

参数解释:

提取码

约束限制:

[0-9a-zA-Z]{8}

取值范围:

不涉及

默认取值:

不涉及

expireTime

String

参数解释:

失效时间

约束限制:

格式:yyyy-MM-dd HH:mm:ss,举例2025-05-27 01:37:49

取值范围:

不涉及

默认取值:

不涉及

comment

String

参数解释:

分享留言

约束限制:

小于512个字符

取值范围:

不涉及

默认取值:

不涉及

validDays

Integer

参数解释:

有效分享天数

约束限制:

不涉及

取值范围:

1~365

默认取值:

不涉及

expiredType

String

参数解释:

失效类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

phoneNumbers

Array of strings

参数解释:

用户手机号列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应信息

shareLink

shareLink object

分享链接信息

请求示例

POST /koodrive/ose/v1/share

{
  "scope" : "1",
  "fileIds" : [ "FryfD0bDk0aWSfrlCgZVJG7hxDMCY5hkl" ],
  "containerId" : "IAAB5thdWzxEoAsiA1681759183084696448",
  "permission" : {
    "download" : true
  },
  "enabledCode" : false,
  "extractCode" : "MDg2K0vU",
  "expireTime" : "2025-04-29T20:01:20.000Z",
  "expiredType" : "2",
  "comment" : "",
  "validDays" : 7
}

响应示例

状态码:200

OK

{
  "shareLink" : {
    "shareId" : "1689743054514187776",
    "shortUrl" : "1689743054514187777",
    "linkUrl" : "1689743054514187777",
    "extractCode" : "MDg2K0vU",
    "comment" : "",
    "expireTime" : "2025-05-27T01:37:49.052Z"
  },
  "code" : 0,
  "msg" : "成功"
}

状态码

状态码

描述

200

OK