文档首页/ 云空间服务 KooDrive/ API参考/ API/ 分享管理-我分享的/ 创建分享 - createShare
更新时间：2026-02-03 GMT+08:00
查看PDF
分享

创建分享 - 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位）

X-User-Id

是

String

用户id，用于app鉴权

X-Date

是

String

日期，用于app鉴权

Host

是

String

地址，用于app鉴权
表2 请求Body参数

参数

是否必选

参数类型

描述

scope

是

Integer

分享范围，1：外链分享（该功能目前只有白名单用户使用），2：仅企业内用户可访问，3：指定企业用户访问

deptIds

否

Array of strings

部门id列表

groupIds

否

Array of strings

用户组id列表

userIds

否

Array of strings

用户id列表

phoneNumbers

否

Array of strings

用户手机号列表； 2B2C场景

fileIds

是

Array of strings

文件id列表

containerId

是

String

空间id

permission

否

SharePermission object

分享权限（后续支持）

extractCode

否

String

提取码

expireTime

否

String

失效时间

comment

否

String

分享留言

validDays

是

Integer

有效分享天数（1-365）
表3 SharePermission

参数

是否必选

参数类型

描述

preview

否

Boolean

预览权限

edit

否

Boolean

编辑权限

download

否

Boolean

下载权限

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应信息

shareLink

shareLink object

分享链接信息
表5 shareLink

参数

参数类型

描述

shareId

String

分享id

shortUrl

String

分享短码

linkUrl

String

分享链接

extractCode

String

提取码

comment

String

留言

expireTime

String

失效时间

请求示例

POST /koodrive/ose/v1/share

Authorization:Bearer+10f88**********4791e9ff

{
  "scope": 0,
  "deptIds": [
    "string"
  ],
  "groupIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "fileIds": [
    "string"
  ],
  "containerId": "string",
  "permission": {
    "preview": true,
    "edit": true,
    "download": true
  },
  "extractCode": "string",
  "expireTime": "2024-06-03T01:54:57.288Z",
  "comment": "string",
  "validDays": 0
}

响应示例

状态码：200

OK

{
  "shareLink" : {
    "shareId" : "1537770199275722240",
    "shortUrl" : "1537770199275722241",
    "linkUrl" : "https://kdconsole-test-gray.hwcloudtest.cn:8080/cloudfile/#/sharelink/i/1537770199275722241",
    "extractCode" : "",
    "comment" : "",
    "expireTime" : "2024-10-29T09:14:52.948Z"
  },
  "code" : 0,
  "msg" : "success"
}

状态码

状态码

描述

200

OK