调用本接口查询指定相似图库中样本图片的信息。
使用说明
业务接口: /green/similarity/image/get
您可以调用该接口查询指定相似图库中样本图片的信息。关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK概览。
QPS限制
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
请求参数
关于公共请求参数,请参见公共参数。
请求body是一个JSON对象,字段说明如下:
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
library | String | 否 | xxxx | 要查询的图库的名称。如果不指定该参数,即从默认图库中查询。默认图库名称为default。 |
dataId | String | 否 | aaa | 要查询的图片样本的ID。
说明 必须传入dataId和URL中的一个。
|
url | String | 否 | http://example.com/x.jpg | 要查询的图片样本的URL。
说明 必须传入dataId和URL中的一个。
|
返回数据
关于返回参数的说明,请参见返回结果。
返回body中的data字段是JSON数组,每一个元素包含如下字段:
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Integer | 200 | 错误码,和HTTP状态码一致。
更多信息,请参见公共错误码。 |
msg | String | OK | 响应消息的请求信息。 |
dataId | String | aaa | 图片的唯一ID。 |
url | String | http://example.com/x.jpg | 图片的链接地址。 |
createTime | Integer | xxx | 在图库中创建图片样本的时间戳。 |
tags | String | xxx | 图片样本的标签。 |
requestId | String | 33921869-CF8A-4E62-8C31-44F37341FFC1 | 本次请求的ID。 |
示例
请求示例
http(s)://[Endpoint]/green/similarity/image/get
&<公共请求参数>
{
"library": "xxxx",
"dataId": "aaa"
}
返回示例
{
"msg": "OK",
"code": 200,
"requestId": "33921869-CF8A-4E62-8C31-44F37341FFC1",
"data":{
"dataId": "aaa",
"createTime":,
"url" :"http:/example.com/x.jpg"
}
}