› 推特 ›阿里云技术文档›正文

ListAlbums_相簿接口_API手册_智能云相册

admin 阿里云技术文档 2020-02-11 219 0
阿里云服务器优惠

ListAlbums

描述

分批获取当前用户的相簿

请求参数

参数名 类型 是否必须 说明
Action String 是 ListAlbums
State String 是 指定需要获取的相簿的状态，可选值有active, deleted和all
StoreName String 是 PhotoStore的名称
Cursor String 否 指定拉取数据的游标。默认值为0，表示从最老的数据开始分批获取。
Direction String 否 指定拉取数据的方向，可选值为backward和forward。forward表示获取比指定游标更新的数据，backward表示获取比指定游标更老的数据。默认值为forward
Size Integer 否 指定服务端返回的最大记录条数，最大值为500。默认值为50。
LibraryId String 否 照片库标识。采用AK认证时必选，采用STS认证时可选。了解不同认证方式的区别。

请求示例

  1. https://cloudphoto.cn-shanghai.aliyuncs.com/?Action=ListAlbums
  2. &Cursor=0
  3. &Direction=forward
  4. &Size=10
  5. &State=all
  6. &StoreName=cloudphoto-demo
  7. &LibraryId=alice-001
  8. &<公共请求参数>

返回参数

参数名 类型 说明
RequestId String 唯一标识本次请求的ID
Code String 响应状态码，Success表示成功的响应
Message String 响应状态详细描述
Action String ListAlbums
Albums Album[] Album数组
NextCursor String 表示获取下一批数据的起始游标，如果为EOF则表示没有数据了。
TotalCount String 符合条件的记录总数

Albums

参数名 类型 说明
Cover 对象 相册的封面
Ctime String 创建的时间戳，单位：毫秒
Id Long 相簿的Id
Mtime String 最后修改的时间戳，单位：毫秒
Name String 相簿的名称
PhotosCount Integer 相簿的中的照片数量
Remark String 备注
State String 相簿的状态

Cover

参数名 类型 说明
Ctime String 创建的时间戳，单位：毫秒
FileId String 照片对应到存储在OSS上的文件名
Height Integer 照片的高度
Id Long 记录的唯一标识
Md5 String 文件的Md5值。如果文件是以OSS分块上传方式上传的话，文件MD5为异步计算，在计算完成以前，MD5值为空。
Mtime String 最后修改的时间戳，单位：毫秒
State String 文件的状态
Title String 照片的名称
Width Integer 照片的宽度
Remark String 备注

返回示例

JSON格式

  1. {
  2.     "TotalCount":5,
  3.     "Action":"ListAlbums",
  4.     "Message":"success",
  5.     "RequestId":"84CFE5E4-1781-4444-B20B-1BDF67EC6B28",
  6.     "NextCursor":"1500088237000000:822891310280093696",
  7.     "Code":"Success",
  8.     "Albums":[
  9.         {
  10.             "Name":"demo-album-1",
  11.             "Mtime":1499998501000000,
  12.             "State":"active",
  13.             "Id":822504789718867968,
  14.             "Ctime":1499996084000000,
  15.             "Cover":{
  16.                 "Md5":"6b680a5ec98537d18c87e9bb40fc0683",
  17.                 "Mtime":1499946529440,
  18.                 "State":"active",
  19.                 "Height":1200,
  20.                 "Id":822296943836270592,
  21.                 "Ctime":1499946529440,
  22.                 "Width":800,
  23.                 "Title":"demo-1.jpg",
  24.                 "FileId":"MkM1N9sjSLe_LWWyxcA80wAAAApwZDIE",
  25.                 "Remark":""
  26.             },
  27.             "Remark":"no remark",
  28.             "PhotosCount":2
  29.         }
  30.     ]
  31. }

XML格式

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <ListAlbumsResponse>
  3.   <Action>ListAlbums</Action>
  4.   <TotalCount>5</TotalCount>
  5.   <Message>success</Message>
  6.   <RequestId>626C5900-FF98-4F14-9FEB-FBB5D707B81F</RequestId>
  7.   <NextCursor>1500088237000000:822891310280093696</NextCursor>
  8.   <Code>Success</Code>
  9.   <Albums>
  10.     <Album>
  11.       <Name>demo-album-1</Name>
  12.       <Mtime>1499998501000000</Mtime>
  13.       <State>active</State>
  14.       <Cover>
  15.         <Mtime>1499946529440</Mtime>
  16.         <Md5>6b680a5ec98537d18c87e9bb40fc0683</Md5>
  17.         <State>active</State>
  18.         <Height>1200</Height>
  19.         <Ctime>1499946529440</Ctime>
  20.         <Id>822296943836270592</Id>
  21.         <Width>800</Width>
  22.         <FileId>MkM1N9sjSLe_LWWyxcA80wAAAApwZDIE</FileId>
  23.         <Title>demo-1.jpg</Title>
  24.         <Remark></Remark>
  25.       </Cover>
  26.       <Ctime>1499996084000000</Ctime>
  27.       <Id>822504789718867968</Id>
  28.       <Remark>no remark</Remark>
  29.       <PhotosCount>2</PhotosCount>
  30.     </Album>
  31.   </Albums>
  32. </ListAlbumsResponse>
版权声明

本文仅代表作者观点，不代表本站立场。
本文系作者授权发表，未经许可，不得转载。

评论

-----