开发者社区> 问答> 正文

云相册的API相簿接口ListAlbums怎么使用



描述


分批获取当前用户的相簿

请求参数

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


请求示例https://cloudphoto.cn-shanghai.aliyuncs.com/?Action=ListAlbums
&Cursor=0
&Direction=forward
&Size=10
&State=all
&StoreName=cloudphoto-demo
&LibraryId=alice-001
&<公共请求参数>





返回参数

参数名类型说明
RequestIdString唯一标识本次请求的ID
CodeString响应状态码,Success表示成功的响应
MessageString响应状态详细描述
ActionStringListAlbums
AlbumsAlbum[]Album数组
NextCursorString表示获取下一批数据的起始游标,如果为EOF则表示没有数据了。
TotalCountString符合条件的记录总数


Albums

参数名类型说明
Cover对象相册的封面
CtimeString创建的时间戳,单位:毫秒
IdLong相簿的Id
MtimeString最后修改的时间戳,单位:毫秒
NameString相簿的名称
PhotosCountInteger相簿的中的照片数量
StateString相簿的状态


Cover

参数名类型说明
CtimeString创建的时间戳,单位:毫秒
FileIdString照片对应到存储在OSS上的文件名
HeightInteger照片的高度
IdLong记录的唯一标识
Md5String文件的Md5值。如果文件是以OSS分块上传方式上传的话,文件MD5为异步计算,在计算完成以前,MD5值为空。
MtimeString最后修改的时间戳,单位:毫秒
StateString文件的状态
TitleString照片的名称
WidthInteger照片的宽度
RemarkString备注


返回示例


JSON格式 {
    "TotalCount":5,
    "Action":"ListAlbums",
    "Message":"success",
    "RequestId":"84CFE5E4-1781-4444-B20B-1BDF67EC6B28",
    "NextCursor":"1500088237000000:822891310280093696",
    "Code":"Success",
    "Albums":[
        {
            "Name":"demo-album-1",
            "Mtime":1499998501000000,
            "State":"active",
            "Id":822504789718867968,
            "Ctime":1499996084000000,
            "Cover":{
                "Md5":"6b680a5ec98537d18c87e9bb40fc0683",
                "Mtime":1499946529440,
                "State":"active",
                "Height":1200,
                "Id":822296943836270592,
                "Ctime":1499946529440,
                "Width":800,
                "Title":"demo-1.jpg",
                "FileId":"MkM1N9sjSLe_LWWyxcA80wAAAApwZDIE",
                "Remark":""
            },
            "PhotosCount":2
        }
    ]
}


XML格式 <?xml version="1.0" encoding="UTF-8"?>
<ListAlbumsResponse>
  <Action>ListAlbums</Action>
  <TotalCount>5</TotalCount>
  <Message>success</Message>
  <RequestId>626C5900-FF98-4F14-9FEB-FBB5D707B81F</RequestId>
  <NextCursor>1500088237000000:822891310280093696</NextCursor>
  <Code>Success</Code>
  <Albums>
    <Album>
      <Name>demo-album-1</Name>
      <Mtime>1499998501000000</Mtime>
      <State>active</State>
      <Cover>
        <Mtime>1499946529440</Mtime>
        <Md5>6b680a5ec98537d18c87e9bb40fc0683</Md5>
        <State>active</State>
        <Height>1200</Height>
        <Ctime>1499946529440</Ctime>
        <Id>822296943836270592</Id>
        <Width>800</Width>
        <FileId>MkM1N9sjSLe_LWWyxcA80wAAAApwZDIE</FileId>
        <Title>demo-1.jpg</Title>
        <Remark></Remark>
      </Cover>
      <Ctime>1499996084000000</Ctime>
      <Id>822504789718867968</Id>
      <PhotosCount>2</PhotosCount>
    </Album>
  </Albums>
</ListAlbumsResponse>

展开
收起
云栖大讲堂 2017-10-27 10:34:37 1772 0
0 条回答
写回答
取消 提交回答
问答排行榜
最热
最新

相关电子书

更多
Spring Boot2.0实战Redis分布式缓存 立即下载
CUDA MATH API 立即下载
API PLAYBOOK 立即下载