开发者社区 问答 正文

云相册的API标签接口ListTagPhotos怎么使用



描述


分批列出当前照片库中的指定标签的照片列表

请求参数

参数名类型是否必须说明
ActionStringListTagPhotos
StateString注意:State不是照片的状态,而是照片与标签关系的状态。可选值为active(表示照片有这个标签),removed(表示该标签已从该照片中移除)和all(表示所有状态)
StoreNameStringPhotoStore的名称
TagIdInteger标签的ID
CursorString指定拉取数据的游标。默认值为0,表示从最老的数据开始分批获取。
DirectionString指定拉取数据的方向,可选值为backward和forward。forward表示获取比指定游标更新的数据,backward表示获取比指定游标更老的数据。默认值为forward
SizeInteger指定服务端返回的最大记录条数,最大值为500。默认值为50。
LibraryIdString照片库标识。采用AK认证时必选,采用STS认证时可选。了解不同认证方式的区别。


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





返回参数

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


Results

参数名类型说明
PhotoIdLong照片的唯一ID
StateString照片与标签的关系的状态


返回示例


JSON格式 {
    "TotalCount":6,
    "Action":"ListTagPhotos",
    "Message":"success",
    "RequestId":"7A8A7A66-D0DE-4147-9845-433F3B5B88E2",
    "NextCursor":"1500380319000000:824116387264872453",
    "Results":[
        {
            "State":"active",
            "PhotoId":824116383510962176
        }
    ],
    "Code":"Success"
}


XML格式 <?xml version="1.0" encoding="UTF-8"?>
<ListTagPhotosResponse>
  <Action>ListTagPhotos</Action>
  <TotalCount>6</TotalCount>
  <Message>success</Message>
  <RequestId>CDCCCEE9-572F-48C4-ACC3-41CF072CFA52</RequestId>
  <NextCursor>1500380319000000:824116387264872453</NextCursor>
  <Results>
    <Result>
      <State>active</State>
      <PhotoId>824116383510962176</PhotoId>
    </Result>
  </Results>
  <Code>Success</Code>
</ListTagPhotosResponse>

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

您提到的请求示例是关于阿里云Cloud Photo服务中的一项功能,用于分批列出照片库中带有指定标签的照片列表。下面是对这个请求及其参数的详细说明,帮助您更好地理解和使用该服务:

请求概述

此API(ListTagPhotos)允许用户根据特定条件查询和获取照片库中与某一标签关联的照片信息。这在组织和管理大量照片时特别有用,尤其是当需要根据标签对照片进行分类或筛选时。

请求参数详解

  • Action (String, 必须): API操作名,固定为ListTagPhotos,表示请求列出带有指定标签的照片。

  • State (String, 必须): 指定查询照片与标签关系的状态。可选值包括:

    • active: 照片当前有这个标签。
    • removed: 标签已从该照片中移除。
    • all: 包含所有状态的照片。
  • StoreName (String, 必须): 照片存储空间的名称,即PhotoStore的名称,在创建照片库时定义。

  • TagId (Integer, 必须): 要查询的标签ID,通过其他API如ListTags可以先获取到标签ID。

  • Cursor (String, 可选): 分页查询的游标,用于控制数据拉取的起始点。默认为0,表示从最老的数据开始。

  • Direction (String, 可选): 数据拉取的方向,可选backward(更老的数据)或forward(更新的数据)。默认为forward

  • Size (Integer, 可选): 单次请求返回的最大记录数,范围1-500,默认为50。

  • LibraryId (String, 可选): 照片库的标识。如果采用AccessKey和AccessKey Secret认证(AK认证),此参数是必须的;若使用STS(Security Token Service)临时凭证认证,则可选。

请求示例解析

https://cloudphoto.cn-shanghai.aliyuncs.com/?Action=ListTagPhotos&State=active&StoreName=my_photo_store&TagId=12345&Cursor=0&Direction=forward&Size=100

在这个示例URL中,用户请求列出状态为active(即带有标签且未被移除)的、存储在名为my_photo_store的照片库中的照片,针对标签ID为12345的照片。查询将从最老的数据开始,向前获取最多100条记录。

注意事项

  • 在实际应用中,确保替换示例中的占位符(如my_photo_store12345等)为实际的值。
  • 使用该服务前,请确保已在阿里云账号下开通了Cloud Photo服务,并正确配置了认证信息。
  • 如果处理大量数据,合理设置Size参数以避免单次请求数据量过大导致的性能问题。
  • 认证方式的选择(AK vs STS)会影响是否需要提供LibraryId,请根据实际情况选择合适的认证方式。
有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答