自定义图片黑库接口
更新时间：2021-03-01
创建自定义图片黑库
创建自定义图片黑库
请求语法
POST /v<version>/image/lib HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 自定义图片黑库名称，最长40个字符 | 是 |
| description | String | 描述，最大支持256字符 | 否 |
请求示例
POST /v1/image/lib HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
{
"name": "test",
"description": "image lib description"
}响应参数
无
响应示例
HTTP/1.1 200 OK删除自定义图片黑库
谨慎使用 该接口会删除自定义图片黑库
- 注：删除图片黑库会导致绑定该库的审核模版不可用，删除图片黑库前请确认已无模版绑定该库。
请求语法
DELETE /v<version>/image/lib/{name} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 库名称 | 是 |
请求示例
DELETE /v1/image/lib/test HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
无
响应示例
HTTP/1.1 200 OK列出所有图片黑库
列出所有自定义图片黑库
请求语法
GET /v<version>/image/lib HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>请求参数
无
请求示例
GET /v1/image/lib HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| libs | Array | 自定义库集合 |
| +name | String | 库名称 |
| +description | String | 描述信息 |
| +count | Integer | 库内图片个数 |
| +createTime | Date | 创建时间 |
响应示例
HTTP/1.1 200 OK
{
"libs": [
{
"name": "test",
"count": 10,
"description": "desc",
"createTime": "2020-12-04T07:23:59Z"
}
]
}添加图片到黑库
往指定的自定义黑库中添加图片。
请求语法
PUT /v<version>/image/lib/{name}?add HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 库名称 | 是 |
| items | Array | 图片地址集合，最多100张 | 是 |
请求示例
PUT /v1/image/lib/test?add HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
{
"items": [
"http://image1.jpg",
"http://image2.jpg"
]
}响应参数
无
响应示例
HTTP/1.1 200 OK从黑库中删除图片
删除指定的自定义黑库中的图片。
请求语法
PUT /v<version>/image/lib/{name}?delete HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 库名称 | 是 |
| items | Array | 图片ID集合，最多100张 | 是 |
请求示例
PUT /v1/image/lib/test?delete HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
{
"items": [
"X2bzk3YBeesIwZTbdF8Y",
"1wx7LHYBeesIwZTb_59J"
]
}响应参数
无
响应示例
HTTP/1.1 200 OK查看黑库中的图片
查看自定义黑库中的图片列表
请求语法
GET /v<version>/image/lib/{name}?pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 库名称 | 是 |
| pageNo | Integer | 分页页数，默认为1 | 否 |
| pageSize | Integer | 分页显示条数，默认为20 | 否 |
请求示例
GET /v1/image/lib/test?pageNo=1&pageSize=20 HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| pageNo | Integer | 分页页数 |
| pageSize | Integer | 分页显示条数 |
| totalCount | Integer | 图片总数 |
| result | Array | 图片列表 |
| + id | String | 图片ID |
| + source | String | 图片地址 |
响应示例
HTTP/1.1 200 OK
{
"pageNo": 1,
"pageSize": 20,
"totalCount": 1,
"result": [
{
"id": "X2bzk3YBeesIwZTbdF8Y",
"source": "https://bj.bcebos.com/test.jpg"
}
]
}