开发者社区 问答 正文

云相册的API搜索接口SearchPhotos怎么使用



描述


搜索照片并分页返回结果

请求参数

参数名类型是否必须说明
ActionStringSearchPhotos
KeywordString搜索的关键字
PageInteger指定服务端返回结果的页数
StoreNameStringPhotoStore的名称
SizeInteger指定服务端返回结果的每页记录条数。默认值为50,最大值为500。
LibraryIdString照片库标识。采用AK认证时必选,采用STS认证时可选。了解不同认证方式的区别。


请求示例https://cloudphoto.cn-shanghai.aliyuncs.com/?Action=SearchPhotos
&Keyword=玩具
&Page=1
&Size=10
&StoreName=cloudphoto-demo
&LibraryId=alice-001
&<公共请求参数>





返回参数

参数名类型说明
RequestIdString唯一标识本次请求的ID
CodeString响应状态码,Success表示成功的响应
MessageString响应状态详细描述
ActionStringSearchPhotos
PhotosPhoto[]Photo数组
TotalCountString符合条件的记录总数


Photos

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


返回示例


JSON格式 {
    "Photos":[
        {
            "IsVideo":false,
            "Md5":"6b680a5ec98537d18c87e9bb40fc0683",
            "Mtime":1499946529440,
            "State":"active",
            "Height":1200,
            "Id":822296943836270592,
            "Ctime":1499946529440,
            "Width":800,
            "Title":"demo-1.jpg",
            "FileId":"MkM1N9sjSLe_LWWyxcA80wAAAApwZDIE"
            "TakenAt":1499946529440
        }
    ],
    "TotalCount":1,
    "Action":"SearchPhotos",
    "Message":"success",
    "RequestId":"12FFCB39-DCB4-4A9F-8C38-15AE9B759687",
    "Code":"Success"
}


XML格式 <?xml version="1.0" encoding="UTF-8"?>
<SearchPhotosResponse>
  <Photos>
    <Photo>
      <IsVideo>false</IsVideo>
      <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>
      <TakenAt>1499946529440</TakenAt>
    </Photo>
  </Photos>
  <Action>SearchPhotos</Action>
  <TotalCount>1</TotalCount>
  <Message>success</Message>
  <RequestId>463B2C76-846D-4D1B-B741-428EE12B3287</RequestId>
  <Code>Success</Code>
</SearchPhotosResponse>

展开
收起
云栖大讲堂 2017-10-27 11:18:11 2249 分享 版权
阿里云 AI 助理回答

您提到的请求示例是关于使用阿里云的Cloud Photo服务来搜索照片并分页返回结果的API调用。Cloud Photo是阿里云提供的一种图片存储与管理服务,它允许用户上传、管理和检索大量的图片资源。下面是对您给出的请求参数和示例的详细解析:

请求参数说明

  1. Action: 必须参数,指定要执行的操作。在这个例子中,SearchPhotos表示搜索照片。

  2. Keyword: 必须参数,用于指定搜索的关键字。系统会根据这个关键字在照片的元数据(如标题、描述等)中进行匹配。

  3. Page: 必须参数,用来指定从哪一页开始返回搜索结果。这对于分页显示大量搜索结果非常有用。

  4. StoreName: 必须参数,表示Photo Store的名称。每个用户可以创建多个Photo Store来分类管理照片。

  5. Size: 可选参数,默认值为50,最大值为500。它定义了每页返回的结果数量,帮助控制响应的数据量大小。

  6. LibraryId: 可选参数,当采用Access Key(AK)认证方式时,此参数是必填的,用于指定照片库的标识。如果使用Security Token Service (STS)认证,则可能不需要此参数。STS是一种临时授权机制,允许用户给予第三方应用有限的访问权限。

请求示例解释

  • URL: https://cloudphoto.cn-shanghai.aliyuncs.com/?Action=SearchPhotos

    这个URL展示了如何构造一个请求到阿里云Cloud Photo服务的HTTP GET请求。其中,.cn-shanghai.aliyuncs.com指定了服务的区域为中国上海区域。后面跟着的是查询字符串,包含了操作名和其他参数。

  • 实际调用时,除了直接在URL后面添加查询参数外,通常还需要通过HTTP Header或POST Body传递安全认证信息,比如AccessKeyId、AccessKeySecret(对于AK认证),或者SecurityToken(对于STS认证),确保请求的安全性。

综上所述,通过调整这些参数,您可以灵活地在Cloud Photo服务中搜索和分页浏览照片。记得在实际调用API前,确保您的应用程序已正确配置了阿里云的认证信息,并了解不同认证方式的具体要求。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答