获取Prompt模板标签列表
更新时间：2026-04-21
POST
https://qianfan.baidubce.com/v2/promptLabels?Action=DescribePromptLabels
本接口用于获取标签列表信息，如标签ID、标签名称、标签类型等。
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID和Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求参数
Headers 参数
除公共头域外，无其它特殊头域
Query 参数
Action
string
方法名称，本接口该字段为固定值DescribePromptLabels
必选
Body 参数
marker
string
标记本次查询的起始位置。首次或首页查询可不传或传空字符串，往后翻页时请传上一次查询响应体中的nextMarker
可选
maxKeys
integer
本次查询包含的最大结果集数量，默认10，建议最大值不超过100
可选
pageReverse
boolean
是否倒序查询，默认为false
可选
请求结构
POST /v2/promptLabels?Action=DescribePromptLabels HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"marker": "",
"maxKeys": 3
}示例代码
请求示例
curl -i --location 'https://qianfan.baidubce.com/v2/promptLabels?Action=DescribePromptLabels'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a5xxxx74525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"marker": "",
"maxKeys": 3
}'返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
requestId
string
请求ID
可选
result
object {2}
请求结果，请求成功时返回
可选
显示子属性
隐藏子属性
items
array
标签数组
可选
显示子属性
隐藏子属性
items
object {5}
显示子属性
隐藏子属性
labelId
string
标签ID
可选
createTime
string
创建时间，格式: ISO 8601
可选
updateTime
string
更新时间，格式: ISO 8601
可选
labelName
string
标签名称
可选
type
string
标签类型，说明：· System：系统预置 · Custom：用户创建。
可选
pageInfo
object {4}
分页信息
可选
显示子属性
隐藏子属性
marker
string
本次查询的起始位置标识
可选
isTruncated
boolean
后面是否还有数据，说明：· true：表示后面还有数据 · false：表示已经是最后一页
可选
nextMarker
string
下次查询的起始位置标记
可选
maxKeys
integer
本次查询的页大小
可选
成功示例
{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"pageInfo": {
"marker": "pl-jseqvd194abe3umb",
"isTruncated": true,
"nextMarker": "pl-sdsfds516ca2f4d02",
"maxKeys": 3
},
"items": [
{
"labelId": "pl-jseqvd194abe3umb",
"createTime": "2023-10-08T11:02:51+08:00",
"updateTime": "2023-10-08T11:02:51+08:00",
"labelName": "sxz2",
"type": "User"
},
{
"labelId": "pl-219b7d3dec2b7fb7",
"createTime": "2023-10-08T11:02:25+08:00",
"updateTime": "2023-10-08T11:02:25+08:00",
"labelName": "sxz1",
"type": "User"
},
{
"labelId": "pl-8ab11516ca2f4d02",
"createTime": "2023-05-29T18:42:44+08:00",
"updateTime": "2023-05-29T18:42:44+08:00",
"labelName": "label2",
"type": "User"
}
]
}
}错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
requestId |
请求ID |
code |
错误码 |
message |
错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
text
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码，也可以查看错误码说明。
评价此篇文章