自定义图片名单查询接口
2024.04.01 11:21:56
接口说明
通过该接口可以查询已抄送的自定义图片名单信息。
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature 参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权
请求
请求地址
| 名称 | 值 |
|---|---|
| HTTP URL | https://as.dun.163yun.com//v1/image/list/pageQuery |
| HTTP Method | POST |
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| Content-Type | String | 固定值："application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成。
公共参数
公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数
业务参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| version | String | 是 | 接口版本号，值为v1 |
| pageNum | Integer | 是 | 页数，大于等于1 |
| pageSize | Integer | 是 | 每页大小，大于等于1 |
| startTime | Long | 是 | 开始时间，必须大于0 |
| endTime | Long | 是 | 结束时间，必须大于0且大于开始时间 |
| type | Integer | 是 | 名单类型，0：相似名单，1：md5精确名单 |
| listType | Integer | 否 | 名单分类，1：白名单，2：黑名单 |
| imageLabel | Integer | 否 | 名单分类（加黑名单时传），100：色情，110：性感低俗，200：广告，210：二维码，300：暴恐，400：违禁，500：涉政 |
| status | Integer | 否 | 名单状态，0：未生效，1：已生效 |
| url | String | 否 | 图片名单url |
| sortType | Integer | 否 | 排序方式： 1：命中次数降序，2：命中次数升序，3：更新时间降序，4：更新时间升序 |
请求体示例
signature=signature&secretId=your_secret_id&businessId=your_businessId_id&nonce=16163&version=v1×tamp=1574653947813&pageNum=1&pageSize=20&startTime=1598951727666&endTime=1598961727666&type=0&listType=2&status=1
响应
响应结果
响应字段如下，响应公共字段已省略，详细见响应公共字段：
| 名称 | 类型 | 是否返回 | 描述 |
|---|---|---|---|
| result | Object[] | 是 | 提交返回结果 |
| ∟ count | Long | 是 | 查询总数量 |
| ∟ rows | Object[] | 是 | 查询列表 |
| ∟ businessId | Long | 是 | 业务ID |
| ∟ businessName | String | 是 | 业务名称 |
| ∟ productName | String | 是 | 产品名称 |
| ∟ uuid | String | 是 | 图片名单的UUID |
| ∟ url | String | 是 | 图片名单的Url |
| ∟ hitCount | Long | 是 | 命中次数 |
| ∟ imageLabel | Long | 是 | 命中的分类标签 |
| ∟ status | Long | 是 | 当前图片的状态 |
| ∟ updateTime | Long | 是 | 更新时间 |
| ∟ imageLabelValid | Long | 是 | 当前配置项是否勾选 |
| ∟ description | Long | 是 | 描述信息 |
| ∟ productId | Long | 是 | 业务对应的产品ID |
| ∟ listType | Long | 是 | 名单类型 |
| ∟ nosPath | Long | 是 | nosPath名单标识 |
| ∟ type | Long | 是 | 名单库，0：黑白名单，1：md5名单 |
响应体示例
{
"code": 200,
"msg": "ok",
"result": {
"count": 1,
"rows": [
{
"businessId": 19008,
"businessName": "businessName",
"productName": "productName",
"uuid": "943bc8bf19574979ac90a63431500625",
"url": "http://n1.itc.cn/img8/wb/sohulife/2020/09/04/159920645893400468.JPEG",
"hitCount": 0,
"imageLabel": 100,
"status": 1,
"updateTime": 1599206746716,
"imageLabelValid": "imageLabelValid",
"description": "description",
"productId": 0,
"listType": 2,
"nosPath": "1599206746640_sf27gci8tw8ph9rc.jpeg",
"type": 0
}
]
}
}
示例代码
服务端 SDK 接入
推荐使用我们提供的服务端 SDK 进行接入（目前支持 Java 和 Go 两种语言），不但可以节省接入成本，实现更快速的集成，并享有灵活的请求配置选项，同时 SDK 内置了错误重试、熔断降级等功能，提升服务可用性。点击 服务端 SDK 接入指引 了解更多。
