更新相册 - UpdateAlbum
功能介绍
更新相册,可以更新收录相册的范围与类型;可以更新手工相册的名称。封面图片coverImageUrl为预留字段,目前手工相册的封面取值为第一张图片的缩略图,收录相册不需要封面。
授权信息
当前API调用无需身份策略权限。
URI
POST /koodrive/ose/v1/{albumId}/update
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| albumId | 是 | String | 参数解释: 相册ID 约束限制: 使用创建相册返回的ID 取值范围: 不涉及 默认值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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表示美式英语 取值范围: 不涉及 默认取值: 不传默认美式英语 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| scopeParentFolderId | 否 | String | 参数解释: 收录范围的父目录ID 约束限制: 收录范围约束为一层目录。所以其父目录ID只有一个 取值范围: 不涉及 默认值: 不涉及 |
| scopeDirList | 否 | Array of strings | 参数解释: 收录范围ID列表 约束限制: 收录范围约束为一层目录。 取值范围: 列表长度最大为30 默认值: 不涉及 |
| scopeKind | 否 | Integer | 参数解释: 收录类型 约束限制: 不涉及 取值范围: 1图片;2视频。 样例:1,2。 默认值: 不涉及 |
| name | 否 | String | 参数解释: 相册名称 约束限制: 不涉及 取值范围: 长度为[1-20]的字符串 默认值: 不涉及 |
| coverImageUrl | 否 | String | 参数解释: 封面图片URL 约束限制: 不涉及 取值范围: 不涉及 默认值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 响应码 |
| msg | String | 响应信息 |
请求示例
重命名一个相册
/koodrive/ose/v1/{albumId}/update
{
"name" : "albumName22"
} 响应示例
状态码:200
更新相册响应
{
"code" : 0,
"msg" : "Success."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新相册响应 |