获取标签列表
更新时间：2025-04-01
接口描述
获取标签列表
权限说明
调用本API，需使用API Key鉴权方式。Authorization的值为Bearer <AppBuilder API Key>。获取API Key流程，请查看授权
接口定义
| URL | /v2/tag?Action=DescribeTags |
|---|---|
| Method | POST |
| Content-Type | application/json |
| Authorization | 请求签名(此签名为应用工作台密钥) |
请求结构
Plain Text
1POST /v2/tag?Action=DescribeTags HTTP/1.1
2HOST: qianfan.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
5{
6 "keyWords":"test",
7 "pageNo":1,
8 "pageSize":3
9}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 字段 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| keyWords | string | 否 | 关键字搜索，模糊匹配key和value |
| pageNo | int | 否 | 页数，默认1 |
| pageSize | int | 否 | 默认20 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段 | 类型 | 必然存在 | 说明 |
|---|---|---|---|
| requestId | string | 是 | 请求ID |
| pageSize | int | 是 | 每页的数量 |
| pageNo | int | 是 | 第几页 |
| hasMore | bool | 是 | 是否还有后续页 |
| total | int | 是 | 总的数量 |
| data | list[Tag] | 是 | 标签数据 |
Tag
| 字段 | 类型 | 必然存在 | 说明 |
|---|---|---|---|
| key | string | 是 | 标签key |
| values | list[String] | 是 | 标签values |
请求curl 示例
Plain Text
1curl --location 'https://qianfan.baidubce.com/v2/tag?Action=ListTags' \
2--header 'Authorization: Bearer authorization string' \
3--header 'Content-Type: application/json' \
4--data '{}'正确响应示例
Plain Text
1HTTP/1.1 200 OK
2{
3 "data": [
4 {
5 "key": "娱乐",
6 "values": [
7 "电影"
8 ]
9 },
10 {
11 "key": "动物",
12 "values": [
13 "爬行动物",
14 "哺乳动物"
15 ]
16 },
17 {
18 "key": "建筑",
19 "values": [
20 "欧式建筑",
21 "中式建筑"
22 ]
23 }
24 ],
25 "pageSize": 10,
26 "pageNo": 1,
27 "hasMore": false,
28 "total": 3,
29 "request_id": "8dde7baa-8ba4-4f83-8b54-52a31d6c4777"
30}错误响应示例
Plain Text
1HTTP/1.1 401
2{
3 "requestId": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
4 "code": "PermissionDeniedError",
5 "message": "没有权限"
6}