开发者社区 问答 正文

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



描述


全量列出当前照片库中照片的标签列表

请求参数

参数名类型是否必须说明
ActionStringListTags
StoreNameStringPhotoStore的名称
LibraryIdString照片库标识。采用AK认证时必选,采用STS认证时可选。了解不同认证方式的区别。


请求示例https://cloudphoto.cn-shanghai.aliyuncs.com/?Action=ListTags
&StoreName=cloudphoto-demo
&LibraryId=alice-001
&<公共请求参数>





返回参数

参数名类型说明
RequestIdString唯一标识本次请求的ID
CodeString响应状态码,Success表示成功的响应
MessageString响应状态详细描述
ActionStringListTags
TagsTag[]Tag数组


Tags

参数名类型说明
Cover对象标签的封面照片
IdString标签的唯一标识
IsSubTagBoolean是否为二级标签,true 是二级标签,false 不是二级标签
ParentTagString一级标签,IsSubTag 是 true 时,输出当前 tag 的一级标签; 为 false 时,即当前 tag 为一级标签,输出空字符串
NameString标签的名称


Cover

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


返回示例


JSON格式 {
    "Tags":[
        {
            "Name":"舞蹈",
            "Id":36864,
            "IsSubTag":false,
            "ParentTag":"",
            "Cover":{
                "Md5":"ac9cc6c68ae7f76d835e110a797baa14",
                "Mtime":1500522991107,
                "State":"active",
                "Height":201,
                "Id":824714799282655232,
                "Ctime":1500522991107,
                "Width":300,
                "Title":"u=125227023,978057929&fm=26&gp=0.jpg",
                "FileId":"To6bm_zeRbKSb0F
Wn2GwAAAApwZDIE",
                "Remark": "Remark"
            }
        }
    ],
    "Action":"ListTags",
    "Message":"success",
    "RequestId":"20BE5A2B-DB6B-410E-8F3B-D137165EAC98",
    "Code":"Success"
}


XML格式 <?xml version="1.0" encoding="UTF-8"?>
<ListTagsResponse>
  <Tags>
    <Tag>
      <Name>舞蹈</Name>
      <IsSubTag>false</IsSubTag>
      <ParentTag></ParentTag>
      <Cover>
        <Mtime>1500522991107</Mtime>
        <Md5>ac9cc6c68ae7f76d835e110a797baa14</Md5>
        <State>active</State>
        <Height>201</Height>
        <Ctime>1500522991107</Ctime>
        <Id>824714799282655232</Id>
        <Width>300</Width>
        <FileId>To6bm_zeRbKSb0FWn2GwAAAApwZDIE</FileId>
        <Title><![CDATA[u=125227023,978057929&fm=26&gp=0.jpg]]></Title>
        <Remark><![CDATA[Remark]]></Remark>
      </Cover>
      <Id>36864</Id>
    </Tag>
  </Tags>
  <Action>ListTags</Action>
  <Message>success</Message>
  <RequestId>584E5FCE-9A5B-4E8E-9C8F-27AD0ACDC007</RequestId>
  <Code>Success</Code>
</ListTagsResponse>

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

您提到的请求示例是关于使用阿里云Cloud Photo服务来全量列出照片库中所有照片的标签列表。Cloud Photo是阿里云提供的一种图片存储与管理服务,它支持对照片进行智能分析并打上标签,便于用户管理和搜索。

请求参数解析:

  • Action: 必须参数,指定要执行的操作。在这个例子中,ListTags表示请求列出照片库中的所有标签。

  • StoreName: 必须参数,指定了Photo Store的名称。Photo Store是Cloud Photo服务中用于存储和管理照片的逻辑空间。

  • LibraryId: 可选参数,当使用Access Key(AK)认证时,这个参数是必须的,用来标识特定的照片库。如果采用Security Token Service (STS)认证,则可能不需要此参数,因为STS token本身已经包含了足够的权限信息。STS是一种临时授权机制,允许用户给予第三方应用有限的访问权限,而无需暴露长期的Access Key和Secret Key。

请求示例说明:

  • URL结构https://cloudphoto.cn-shanghai.aliyuncs.com/ 是Cloud Photo服务的API接入点,其中.cn-shanghai.aliyuncs.com表明该请求指向的是阿里云上海区域的服务端点。不同的阿里云区域会有不同的端点地址。

  • 查询字符串:在URL后面通过?开始添加请求参数,格式为key=value&key2=value2...。在这个例子中,只展示了Action=ListTags这一部分,实际请求时还需包含其他必填参数,如StoreName,以及根据认证方式决定是否需要的LibraryId

实际操作建议:

  1. 构造完整请求:确保在实际发起请求时,除了ActionStoreName外,根据您的认证方式正确添加LibraryId(如果需要)以及其他可能的认证信息(如签名、时间戳等),以完成整个HTTP请求。

  2. 认证方式选择:如果您计划在服务器到服务器的通信中使用此API,通常推荐使用AK认证。若涉及第三方应用或临时授权场景,考虑使用STS认证,以提高安全性。

  3. 查看文档:详细操作指南和参数说明,请参考阿里云官方文档的Cloud Photo服务部分,以获取最新的API调用方法、错误码解释及示例代码等。

  4. 测试与调试:利用阿里云提供的OpenAPI Explorer工具,可以在线构建和测试API请求,帮助您快速验证请求参数和响应结果,无需事先部署代码。

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