查看相簿 - ListAlbums
功能介绍
查看相簿(相册列表)
授权信息
当前API调用无需身份策略权限。
URI
GET /koodrive/ose/v1/album/list
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| albumKind | 是 | Integer | 参数解释: 相册类别: 约束限制: 不涉及 取值范围: 1个人相册;2共享相册 默认值: 不涉及 |
| albumType | 是 | Integer | 参数解释: 相册类型 约束限制: 不涉及 取值范围: 1收录相册;2手工相册 默认值: 不涉及 |
| groupId | 否 | String | 参数解释: 家庭的用户组ID 约束限制: 使用创建家庭后返回的groupId 取值范围: 不涉及 默认值: 不涉及 |
| pageSize | 否 | Integer | 参数解释: 分页大小 约束限制: 不涉及 取值范围: [1-100] 默认值: 10 |
| pageNum | 否 | Integer | 参数解释: 分页数量 约束限制: 不涉及 取值范围: 大于0的整数 默认值: 1 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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' ; 例如20251103T070140Z 取值范围: 距当前时间15分钟以内,不能晚于当前时间 默认值: 不涉及 |
| language | 否 | String | 参数解释: 国际化语言标识 约束限制: 符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语 取值范围: 不涉及 默认取值: 不传默认美式英语 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| albumList | Array of AlbumItem objects | 相册列表 |
| total | Integer | 总数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 相册id |
| name | String | 相册名;手工相册时返回 |
| coverImg | String | 相册封面;手工相册时返回 |
| albumType | Integer | 相册类型:1收录相册;2手工相册 |
| albumKind | Integer | 相册类别:1个人相册;2共享相册 |
| scopeDir | Array of strings | 收录范围:当type=1时候用,folderId1,folderId2,folderId3 |
| scopeKind | String | 收录类型:1图片;2视频 样例:1,2 |
| scopeParentFolderId | String | 收录范围的父目录Id |
| createTime | String | 创建时间 |
| updateTime | String | 更新时间 |
| albumOwnerId | String | 相册ownerId |
请求示例
查询相册列表
/koodrive/ose/v1/album/list?albumKind=1&albumType=2&pageSize=100&pageNum=1 albumKind=1&albumType=2&pageSize=100&pageNum=1
响应示例
状态码:200
相册列表响应
{
"albumList": [
{
"id": "1795607640592646273",
"name": "88888",
"coverImg": "https://obs-xxxx.myhuaweicloud.com/96e9758b7db047fcbc327266c85f1bd7086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27ms_kt%253Durl%26at%253Dori%26key%253DaHR0cHM6Ly9xY2xvdWQuZHBmaWxlLmNvbS9wYy9XUnZfSk9iOTYzVm1vbjJkQTlQY0lLV25GWVlnTWxIY2RGb2tYSGVESWNSNjV6Y0dDd0szVU1WbV8tMlI4S0xUWTBxNzNzQjJEeVFjZ21LVXhaRlF0dy5qcGc%253D%26sign%253Dyx_CIR6buct8Z.jpg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251027T090540Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=HPUA8WFGVY35JSJDL1GV%2F20251027%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=bd99ab2471fb6d0737834d5bc95950693c3710692db8591a10cc112416031d15",
"albumType": 2,
"albumKind": 1,
"createTime": "2025-10-13T03:11:51.147Z",
"updateTime": "2025-10-13T03:11:51.147Z",
"albumOwnerId": "1765263620687613825"
},
{
"id": "1784744274928137601",
"name": "3333332",
"coverImg": "https://obs-xxxx.myhuaweicloud.com/2dece6a7dbab49168a97f552e7e1395f086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27853ce32e95d7b7f07a1702b85b3f85a5_20250922_143618.jpeg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251027T090540Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=HPUA8WFGVY35JSJDL1GV%2F20251027%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=375a759de79bc0ac53c8880b9c7c88fb40c2d6494e711f161498a03ea70d3016",
"albumType": 2,
"albumKind": 1,
"createTime": "2025-09-28T03:28:17.049Z",
"updateTime": "2025-09-29T09:15:08.862Z",
"albumOwnerId": "1765263620687613825"
},
],
"total": 2,
"code": 0,
"msg": "Success."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 相册列表响应 |