本文介绍查看图片数据列表ListImages的语法及示例。

功能描述

查看图片数据列表能力可以查看指定数据库中的图片数据列表。

前提条件

请确保您已开通视觉搜索服务,若未开通服务请立即开通

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListImages

系统规定参数。取值:ListImages

DbName String default

数据库名称。

Token String 2

Offset和Limit组合的分页方式只支持前2000条记录。当超过2000条时,需要使用上一次请求返回的Token作为请求下一页的参数。

Offset Integer 1

起始记录。

Limit Integer 50

每页最多显示的条数。

Order String asc

排列方式。包括升序(asc)和降序(desc)。

EntityIdPrefix String U1

样本ID前缀。

返回数据

名称 类型 示例值 描述
RequestId String 2B93C43A-F824-40C8-AF79-844342B0F43A

请求ID。

Data Object

返回的结果数据内容。

ImageList Array of ImageList

返回的图片数据列表。

EntityId String 5

实体ID或分组ID。

CreatedAt Long 1582838489213

创建数据的时间。

UpdatedAt Long 1582838489213

更新数据的时间。

DataId String 001

数据ID。

ExtraData String 元素

自定义数据内容。

Token String 2

Offset和Limit组合的分页方式只支持前2000条记录。

当超过2000时,需要使用上一次请求返回的Token作为请求下一页的参数。

TotalCount Integer 100

总数量。

示例

请求示例

http(s)://imgsearch.cn-shanghai.aliyuncs.com/?Action=ListImages
&DbName=default
&Token=2
&Offset=1
&Limit=50
&Order=asc
&EntityIdPrefix=U1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>2B93C43A-F824-40C8-AF79-844342B0F43A</RequestId>
<Data>
    <Token>2</Token>
    <TotalCount>100</TotalCount>
    <ImageList>
        <DataId>22</DataId>
        <ExtraData>元素</ExtraData>
        <EntityId>5</EntityId>
        <UpdatedAt>1582838489213</UpdatedAt>
        <CreatedAt>1582838489213</CreatedAt>
    </ImageList>
</Data>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2B93C43A-F824-40C8-AF79-844342B0F43A",
  "Data" : {
    "Token" : "2",
    "TotalCount" : "100",
    "ImageList" : [ {
      "DataId" : "22",
      "ExtraData" : "元素",
      "EntityId" : "5",
      "UpdatedAt" : 1582838489213,
      "CreatedAt" : 1582838489213
    } ]
  }
}

错误码

关于查看图片数据列表的错误码,详情请参见常见错误码

SDK参考

阿里云视觉AI能力支持使用SDK调用,具体可参见SDK总览下载安装。

安全声明

  • 请确保上传的图片或文件来源符合相应的法律法规。
  • 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。