获取预置服务列表
本接口用于根据服务ID,获取预置服务列表。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 完全控制千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataFullControlAccessPolicy
- 运维操作千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataOperateAccessPolicy
鉴权说明
调用本文API,使用"基于安全认证AK/SK"进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求参数
方法名称,固定值DescribePresetServices
服务ID,说明:
(1)如果填写,表示按照服务ID筛选
(2)如果不填,表示获取全部预置服务列表
(3)该字段可以通过查看预置服务列表获取:打开模型服务-模型推理-预置服务查看。
显示子属性
隐藏子属性
服务类型,说明:
(1)填写此参数,表示按服务类型进行筛选
(2)可选值如下:
· chat
· completions
· text2image
· image2text
显示子属性
隐藏子属性
可选值: chat, completions, text2image, image2text
付费方式,说明:
(1)填写此参数,表示按付费方式进行筛选
(2)可选值如下:
· TPM:TPM付费
· Tokens: Tokens量包
· Calls:按量后付费
· Free:免费调用
显示子属性
隐藏子属性
可选值: TPM, Tokens, Calls, Free
付费状态,说明:
(1)填写此参数,表示按付费状态进行筛选
(2)可选值如下:
· NotOpen:未开通
· Opened:已开通
· Stopped:欠费停止
· Free:免费调用
显示子属性
隐藏子属性
可选值: NotOpen, Opened, Stopped, Free
服务协议版本,可选值如下:
· 1,默认1
· 2
POST /v2/service?Action=DescribePresetServices HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{}
示例代码
curl --location 'https://qianfan.baidubce.com/v2/service?Action=DescribePresetServices' \
--header 'Authorization: bce-auth-v1/047ab241badxxxx28b1ac/2023-10-10T07:48:39Z/1800/host;x-bce-date/c26e0a21944cc53xxxxxxd10cb53f' \
--header 'x-bce-date: 2023-10-10T07:48:17Z' \
--header 'Content-Type: application/json' \
--data ''
返回响应
请求ID
请求结果
显示子属性
隐藏子属性
服务列表
显示子属性
隐藏子属性
服务列表项
显示子属性
隐藏子属性
服务ID
服务名称
服务URL
接入点
服务类型,说明:
· chat
· completions
· text2image
· image2text
是否是公共服务
预置模型ID,为空表示无相关预置模型
预置模型版本ID,为空表示无相关预置模型
对应推理服务API V2的model参数值,当portocolVersion = 2时,返回该字段
付费方式,说明:
· TPM: TPM付费
· Tokens: Tokens量包
· Calls: 按量后付费
· Free: 免费调用
付费状态,说明:
· NotOpen: 未开通
· Opened: 已开通
· Free: 免费调用
是否绑定日志投递
日志投递信息
显示子属性
隐藏子属性
日志集所在地域。当enableLogs为true,显示logRegion
日志组名称。当enableLogs为true,显示logProject
日志集名称。当enableLogs为true,显示logStoreName
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"serviceList":[
{
"serviceId": "svcp-dywitgcxaq6j",
"name": "ERNIE-4.0-8K",
"url": "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions",
"endpoint":"ernie-x1-turbo-32k",
"serviceType": "chat",
"isPublic": true,
"modelSetId":"am-xxx",
"modelId":"amv-xxx",
"chargeType": "TPM",
"chargeStatus": "Opened",
"enableLogs": true,
"logStoreConfig": {
"logRegion": "bj",
"logProject": "default",
"logStoreName": "test02"
}
}
]
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
| 名称 | 描述 |
|---|---|
requestId |
请求ID |
code |
错误码 |
message |
错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。
