开发者社区 问答 正文

云相册的API人脸接口ListFacePhotos怎么使用



描述


分批列出包含该人脸的照片

请求参数

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


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





返回参数

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


Results

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


返回示例


JSON格式 {
    "TotalCount":1,
    "Action":"ListFacePhotos",
    "Message":"success",
    "RequestId":"C7535E87-F546-4DE1-A53F-266BC5E6E7EA",
    "NextCursor":"1500628852200:824117121146429440",
    "Results":[
        {
            "State":"active",
            "PhotoId":824117117514162176
        }
    ],
    "Code":"Success"
}


XML格式 <?xml version="1.0" encoding="UTF-8"?>
<ListFacePhotosResponse>
  <Action>ListFacePhotos</Action>
  <TotalCount>1</TotalCount>
  <Message>success</Message>
  <RequestId>D3BF1878-7759-4054-88BC-50876E5B20DA</RequestId>
  <NextCursor>1500628852200:824117121146429440</NextCursor>
  <Results>
    <Result>
      <State>active</State>
      <PhotoId>824117117514162176</PhotoId>
    </Result>
  </Results>
  <Code>Success</Code>
</ListFacePhotosResponse>

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

您提到的请求示例是关于阿里云的“Cloud Photo”服务中一个具体的操作——ListFacePhotos。这个API用于分批列出与特定人脸ID关联的照片,这些照片可能处于不同的状态(active、removed或all)。下面是该请求的详细解析和使用指导:

请求目的

  • 主要功能:根据给定的人脸ID (FaceId),查询并列出与之相关联的所有照片。这在构建人脸识别应用、管理个人相册或进行图像内容分析时非常有用。
  • 状态筛选:通过 State 参数,您可以选择查看活跃状态的照片(仍在人脸相簿中)、已移除的照片,或是所有状态的照片。
  • 分批获取:为了处理大量数据,此接口支持分批拉取数据,通过 CursorDirectionSize 参数来控制数据的检索范围和顺序。

请求参数详解

  1. Action: 必填,操作名,固定为 ListFacePhotos
  2. FaceId: 必填,指定要查询的人脸的唯一标识符。
  3. State: 必填,指定查询照片的状态,可选值为 activeremovedall
  4. StoreName: 必填,存储空间(PhotoStore)的名称,这是您的照片存储区域的标识。
  5. Cursor: 可选,用于分页查询的游标,默认从最老的数据开始。
  6. Direction: 可选,拉取数据的方向,forward 表示获取更新的数据,backward 表示获取更旧的数据,默认为 forward
  7. Size: 可选,单次请求返回的最大记录数,默认为50,最大不超过500。
  8. LibraryId: 可选,在采用AccessKey认证时需要提供,用于标识照片库;如果使用STS临时凭证认证,则可能不需要此参数。

请求示例说明

  • URL格式https://cloudphoto.aliyuncs.com/?Action=ListFacePhotos&其他参数...
  • 地域信息:示例中的 cn-shanghai 指示了请求的目标地域,实际使用时需替换为您实际使用的阿里云服务区域。

注意事项

  • 确保已开通阿里云Cloud Photo服务,并正确配置了访问密钥(AccessKey ID/Secret)或使用STS临时凭证进行认证。
  • 根据实际需求调整查询参数,特别是 Size 参数,以平衡查询效率和数据量。
  • 请遵循阿里云API调用的最佳实践,包括错误处理、重试机制等。

通过上述API调用,您可以有效地管理和检索存储在阿里云Cloud Photo服务中与特定人脸相关的照片资源。

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