图片/应用关联的名单信息查询
1. 请求
1.1 请求地址
区域 | 请求地址 |
---|---|
国内 | https://api.open.tuputech.com/v3/management/image-library/search/<secretId> |
提示
<secretId>
需替换为您的应用 SID
,请联系客户经理为您开通及配置。关于 SID
详见 常见问题(FAQ)。
1.2 请求方法
POST
1.3 请求头
Content-Type: application/json
1.4 请求参数
参数名称 | 类型 | 是否必需 | 说明 |
---|---|---|---|
timestamp | Number | 是 | 当前服务器的 Unix 时间戳,可以是毫秒或秒级。 |
nonce | Number | 是 | 随机数,建议是 [0-1] 之间的小数,如:0.1527317095951506 。 |
signature | String | 是 |
|
name | String | 否 | 图片名称,支持模糊搜索 |
isFuzzySearch | Boolean | 否 | 是否模糊搜索, 默认为 false |
1.5 请求示例
{
"name": "<name>",
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>"
}
2. 响应
2.1 响应内容
参数名称 | 类型 | 说明 |
---|---|---|
json | String | 响应内容 JSON 转义后的字符串 |
signature | String | 响应内容签名 |
2.2 响应参数
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
code | Number | 否 | 状态码 |
nonce | Number | 否 | 随机数 |
message | String | 否 | 相关信息 |
timestamp | Number | 否 | 时间戳 |
imageLibraries | Array<ImageLibrary> | 否 | 名单信息,详见 imageLibrary 说明 |
ImageLibrary 说明
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
id | String | 否 | 图片名单 ID |
name | String | 否 | 图片名单名称,长度小于等于 512 个字符 |
type | Number | 否 | 图片名单类型(黑白名单) |
threshold | Number | 否 | 图片名单阈值 |
status | Number | 否 | 图片名单状态 |
images | Number | 否 | 图片名单图片数量 |
2.3 响应示例
{
"json": "{\"code\":0,\"imageLibraries\":[{\"id\":\"xxxxx\",\"name\":\"xxxxxx\",\"type\":0,\"threshold\":0.95,\"status\":0,\"images\":0}],\"message\":\"success\",\"nonce\":0.06782758396322386,\"timestamp\":1669603717}",
"signature": "Ib83QDNUBz8fvUc2xhELAm7gGqjpIkUkxqw1LaS88ssOSuv52gD3Z3ynu8QL+pLF0S5f6EXmJYH6enOHjymuIYxbg+ToLq6+BGQQWKRyoOEpNzdtmjSqCcv+rO24sH+S76ts0PHyoz0rFUXcxjZl+aRtc0c9bOC/NgpgY+WCBkk="
}