描述
分批列出当前照片库中的指定标签的照片列表
请求参数
参数名 | 类型 | 是否必须 | 说明 |
Action | String | 是 | ListTagPhotos |
State | String | 是 | 注意:State不是照片的状态,而是照片与标签关系的状态。可选值为active(表示照片有这个标签),removed(表示该标签已从该照片中移除)和all(表示所有状态) |
StoreName | String | 是 | PhotoStore的名称 |
TagId | Integer | 是 | 标签的ID |
Cursor | String | 否 | 指定拉取数据的游标。默认值为0,表示从最老的数据开始分批获取。 |
Direction | String | 否 | 指定拉取数据的方向,可选值为backward和forward。forward表示获取比指定游标更新的数据,backward表示获取比指定游标更老的数据。默认值为forward |
Size | Integer | 否 | 指定服务端返回的最大记录条数,最大值为500。默认值为50。 |
LibraryId | String | 否 | 照片库标识。采用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
&<公共请求参数>
参数名 | 类型 | 说明 |
RequestId | String | 唯一标识本次请求的ID |
Code | String | 响应状态码,Success表示成功的响应 |
Message | String | 响应状态详细描述 |
Action | String | ListTagPhotos |
NextCursor | String | 表示获取下一批数据的起始游标,如果为EOF则表示没有数据了。 |
Results | 数组 | 详见结果信息 |
TotalCount | String | 符合条件的记录总数 |
参数名 | 类型 | 说明 |
PhotoId | Long | 照片的唯一ID |
State | String | 照片与标签的关系的状态 |
{
"TotalCount":6,
"Action":"ListTagPhotos",
"Message":"success",
"RequestId":"7A8A7A66-D0DE-4147-9845-433F3B5B88E2",
"NextCursor":"1500380319000000:824116387264872453",
"Results":[
{
"State":"active",
"PhotoId":824116383510962176
}
],
"Code":"Success"
}
<?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>
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
您提到的请求示例是关于阿里云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_store
、12345
等)为实际的值。Size
参数以避免单次请求数据量过大导致的性能问题。LibraryId
,请根据实际情况选择合适的认证方式。