创建相册 - CreateAlbum
功能介绍
创建相册
授权信息
当前API调用无需身份策略权限。
URI
POST /koodrive/ose/v1/album/create
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| X-Traceid | 否 | String | 参数解释: 业务跟踪id(必须58位) 约束限制: 不涉及 取值范围: 长度为58位 默认值: 不涉及 |
| X-Date | 是 | String | 参数解释: 日期,用于app鉴权 约束限制: 日期格式:yyyyMMDD'T'HHmmss'Z' ; 例如20251103T070140Z 取值范围: 距当前时间15分钟以内,不能晚于当前时间 默认值: 不涉及 |
| X-User-Id | 是 | String | 参数解释: KooDrive侧用户id,用于app鉴权 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
| language | 否 | String | 参数解释: 国际化语言标识 约束限制: 符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语 取值范围: 不涉及 默认取值: 不传默认美式英语 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 相册名 约束限制: 手工相册时必填,收录相册非必填 取值范围: 长度为[1-20]个字符 默认值: 不涉及 |
| type | 是 | String | 参数解释: 相册类型: 约束限制: 不涉及 取值范围: 1收录相册;2手工相册; 默认值: 不涉及 |
| scopeDir | 否 | Array of strings | 参数解释: 收录范围 约束限制: 相册类型为1时需要scope相关字段 取值范围: 最多30个目录ID 默认值: 不涉及 |
| scopeParentFolderId | 否 | String | 参数解释: 收录范围的父目录Id 约束限制: 相册类型为1时需要scope相关字段 取值范围: 不涉及 默认值: 不涉及 |
| scopeKind | 否 | String | 参数解释: 相册的收录类型 约束限制: 相册类型为1时需要scope相关字段 取值范围: 1图片;2视频 样例:1,2 默认值: 不涉及 |
| groupId | 否 | String | 参数解释: 关联的共享群组ID 约束限制: 当album_kind=2 时需要此参数值 取值范围: 不涉及 默认值: 不涉及 |
| albumKind | 是 | String | 参数解释: 相册类别 约束限制: 不涉及 取值范围: 1个人相册;2共享相册 默认值: 不涉及 |
| shareFolderId | 否 | Long | 参数解释: 关联的共享文件夹主键(家庭空间ID)并非文件夹id 约束限制: 当album_kind=2 时需要此参数 取值范围: 不涉及 默认值: 不涉及 |
| containerId | 否 | String | 参数解释: 收录范围的的空间ID 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| albumId | String | 相册Id |
请求示例
创建一个相册
/koodrive/ose/v1/album/create
{
"name" : "albumName",
"type" : 2,
"albumKind" : 1
} 响应示例
状态码:200
创建相册响应
{
"albumId" : "1805929618625036417",
"code" : 0,
"msg" : "Success."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建相册响应 |