获取预置服务列表
更新时间：2024-11-08
功能介绍
本接口用于根据服务ID，获取预置服务列表。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 管理员权限：QianfanFullControlAccessPolicy
- 模型服务运维权限：QianfanServiceOperateAccessPolicy
- 模型服务只读权限：QianfanServiceReadAccessPolicy
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址： https://qianfan.baidubce.com/v2/service
请求方式： POST
- Header参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值application/json |
| x-bce-date | string | 否 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 |
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribePresetServices |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| serviceIds | List<string> | 否 | 服务ID，说明： （1）如果填写，表示按照服务ID筛选 （2）如果不填，表示获取全部预置服务列表（3）该字段可以通过查看预置服务列表获取：打开模型服务-模型推理-预置服务查看，如下图所示  |
| serviceType | List<string> | 否 | 服务类型，说明： （1）填写此参数，表示按服务类型进行筛选 （2）可选值如下： · chat · completions · text2image · image2text |
| chargeType | List<string> | 否 | 付费方式，说明： （1）填写此参数，表示按付费方式进行筛选 （2）可选值如下： · TPM：TPM付费 · Tokens： Tokens量包 · Calls：按量后付费 · Free：免费调用 |
| chargeStatus | List<string> | 否 | 付费状态，说明： （1）填写此参数，表示按付费状态进行筛选 （2）可选值如下： · NotOpen：未开通 · Opened：已开通 · Stopped：欠费停止 · Free：免费调用 |
响应说明
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| result | object | 请求结果 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| serviceList | List<serviceItem> | 服务列表 |
serviceItem说明
| 名称 | 类型 | 描述 |
|---|---|---|
| serviceId | string | 服务ID |
| name | string | 服务名称 |
| url | string | 服务URL |
| serviceType | string | 服务类型，说明： · chat · completions · text2image · image2text |
| isPublic | bool | 是否是公共服务 |
| modelSetId | string | 预置模型ID，为空表示无相关预置模型 |
| modelId | string | 预置模型版本ID，为空表示无相关预置模型 |
| chargeType | string | 付费方式，说明： · TPM: TPM付费 · Tokens: Tokens量包 · Calls: 按量后付费 · Free: 免费调用 |
| chargeStatus | string | 付费状态，说明： · NotOpen: 未开通 · Opened: 已开通 · Free: 免费调用 |
| enableLogs | bool | 是否绑定日志投递 |
| logStoreConfig | object | 日志投递信息 |
logStoreConfig说明
| 名称 | 类型 | 描述 |
|---|---|---|
| logRegion | string | 日志集所在地域。当enableLogs为true，显示logRegion |
| logProject | string | 日志组名称。当enableLogs为true，显示logProject |
| logStoreName | string | 日志集名称。当enableLogs为true，显示logStoreName |
请求示例
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 ''响应示例
{
"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",
"serviceType": "chat",
"isPublic": true,
"modelSetId":"am-xxx",
"modelId":"amv-xxx",
"chargeType": "TPM",
"chargeStatus": "Opened",
"enableLogs": true,
"logStoreConfig": {
"logRegion": "bj",
"logProject": "default",
"logStoreName": "test02"
}
}
]
}
}SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考获取预置服务列表。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。