视频监控 > API 文档 > 模板管理相关接口 >图像底库 > 实体列表

实体列表

最近更新时间: 2022-12-22 11:25:59

描述

本接口用于获取图像库里的所有实体信息。

接口请求域名：qvs.qiniuapi.com
请求方式：GET
接口路径：/v1/imagelibs/{libId}/entities?offset=<offset>&line=<line>&match=<match>&sortBy=<sortBy>
Get请求，通过非SDK方式调用的客户，http头部Content-Type,要么设置为application/x-www-form-urlencoded,要么置空, 要么不要携带; 公共http header说明

请求参数

路径参数

参数名称	必填	字段类型	说明
libId	是	string	图像库ID
line	否	integer	一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取
offset	否	integer	偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sort	否	string	默认按创建时间降序排列，sort由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序
match	否	string	模糊匹配查询(名称或者证件号包含{match})

响应参数

参数名称	类型	说明
libId	string	库id
name	string	库名称
desc	string	备注描述
createdAt	integer	库创建时间
items	图像库里的所有实体	数组
items.id	string	实体id
items.urls	数组	实体的图像地址的数组
items.name	string	姓名
items.gender	string	性别 male 或 female
items.phoneNum	string	手机号
items.certNum	string	证件号
items.Addr	string	地址
items.desc	string	备注描述
items.createdAt	integer	图像创建时间
total	integer	总数量

示例

请求示例

curl --request GET \
  --url http://qvs.qiniuapi.com/v1/imagelibs/xxx/entities \
  --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='

响应示例

{
  "items": [
    "libId":"xxx",
    "name":"imagelib",
    {
      "id": "2akrars5b81f5",
      "urls":["https://yyy/yy/yy"],
      "name": "test0016",
      "desc": "this is a test",
      "createdAt": 1586850533
    },
    {
      "id": "d102sns2mwhd",
      "urls":["https://ttt.com/rts"],
      "name": "test009",
      "createdAt": 1585104103
    }
  ],
  "total": 2
}

以上内容是否对您有帮助？