调用本接口分页查询所有相似图库及其元信息。

使用说明

业务接口:/green/similarity/library/list

您可以调用该接口查询图库列表。关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK概览

QPS限制

本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

请求参数

关于公共请求参数,请参见公共参数

请求body是一个JSON对象,字段说明如下:

名称 类型 是否必须 示例值 描述
pageSize Integer 5 每页大小,取值范围:(0,50]。
currentPage Integer 1 当前页码,取值范围:(0,50]。

返回数据

关于返回参数的说明,请参见返回结果

返回body中的data字段是JSON数组,每一个元素包含如下字段:

名称 类型 示例值 描述
code Integer 200 错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

msg String OK 请求信息的响应消息。
data JSONArray 相似图库列表。每个元素的结构描述见data
totalCount Integer 1 图库总数量。
pageSize Integer 5 页面大小。
currentPage Integer 1 当前页码。
requestId String 33921869-CF8A-4E62-8C31-44F37341FFC1 本次请求的ID。
表 1. data
名称 类型 示例值 描述
name String xxx 图库名称。
createTime Integer xxx 创建图库的时间戳。
imageCount Integer 0 图库中样本图片的数量。
region String cn-shanghai 图库所属区域。

示例

请求示例

http(s)://[Endpoint]green/similarity/library/list
&<公共请求参数>
{
  "pageSize":5,
  "currentPage":1 
}

返回示例

{
  "msg": "OK", 
  "code": 200, 
  "requestId": "33921869-CF8A-4E62-8C31-44F37341FFC1",
  "data":[
     {
        "name": "xxx",
        "createTime":,
        "imageCount":0,
        "region":"cn-shanghai"
     }
  ],
  "totalCount":1,
  "pageSize":5,
  "currentPage":1 
}