创建自定义logo库
更新时间:2024-08-02
文档中提到的库指的是lib,库集指的是brief,库集素材指的是image。库里包含库集,库集里包含库集素材集合。
图片URL仅支持http或https协议。
创建自定义logo库
请求语法
POST /v{version}/logo/lib HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
路径参数
无
请求参数
无
请求体
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
lib | String | logo库名称 | 是,长度不超过20,支持小写字母、数字和_,以字母开头,且必须全局唯一 |
description | String | 图片描述 | 否,长度不超过256 |
请求示例
POST /v1/logo/lib HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"lib": "test",
"description": "test logo lib"
}
响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OK
列出所有logo库
请求语法
GET /v{version}/logo/lib HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
路径参数
无
请求参数
无
请求体
无
请求示例
GET /v1/logo/lib HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
响应头域
无
响应体
参数 | 类型 | 描述 |
---|---|---|
libs | 对象数组 | logo库列表 |
+userId | String | 用户id |
+lib | String | logo库名称 |
+createTime | Date | logo库创建时间 |
+description | String | logo库描述 |
响应示例
HTTP/1.1 200 OK
{
"libs": [
{
"userId": "6dbd5b0f9fed4b40871428310b8dd0f3",
"lib': 'test",
"createTime': "2019-01-01T00:00:00Z",
"description": "test logo lib"
}
]
}
logo库集素材添加
往指定的logo库集添加图片。
请求语法
POST /v{version}/logo/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
路径参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
lib | String | logo库名 | 是 |
请求参数
无
请求体
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
image | String | 图片url | 是 |
brief | String | 图片描述 | 否 |
请求示例
POST /v1/logo/lib/test HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"image": "http://image.domain.com/dir/image_path.jpg",
"brief": "name"
}
响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OK
删除自定义logo库
请求语法
DELETE /v{version}/logo/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
路径参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
version | String | 版本 | 是 |
lib | String | logo库名 | 是 |
请求参数
无
请求体
无
请求示例
DELETE /v1/logo/lib/test HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
}
响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OK
logo库集素材删除
删除指定的库集素材。
请求语法
DELETE /v{version}/logo/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
路径参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
lib | String | logo库名 | 是 |
请求参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
image | String | 图片url | 是 |
请求体
无
请求示例
DELETE /v1/logo/lib/test?image=http://image.domain.com/dir/image_path.jpg HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
}
响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OK
logo库集素材列表
根据logo库集名称查询库集素材集合。
请求语法
GET /v{version}/logo/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
路径参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
lib | String | logo库名 | 是 |
请求参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
brief | String | 图片描述 | 是 |
请求体
无
请求示例
GET /v1/logo/lib/test?brief=test_name HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
}
响应头域
无
响应体
参数 | 类型 | 描述 |
---|---|---|
images | String数组 | 图片url列表 |
响应示例
HTTP/1.1 200 OK
{
"images": [
"http://bos.bucket.baidu.com/demo_image0.jpg",
"http://bos.bucket.baidu.com/demo_image1.jpg"
]
}
logo库集删除
根据指定的logo库集名称删除库集。
请求语法
DELETE /v{version}/logo/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
路径参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
lib | String | logo库名 | 是 |
请求参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
brief | String | 图片描述 | 是 |
请求体
无
请求示例
DELETE /v1/logo/lib/test?brief=test_name HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
}
响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OK
logo库集列表
查询logo库集名称集合。
请求语法
GET /v{version}/logo/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json
支持v1
、v2
路径参数
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
lib | String | logo库名 | 是 |
请求参数
无
请求体
无
请求示例
GET /v1/logo/lib/test HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
}
响应头域
无
响应体
参数 | 类型 | 描述 |
---|---|---|
briefs | String数组 | 图片描述列表 |
响应示例
HTTP/1.1 200 OK
{
"briefs": [
"name0", "name1"
]
}