获取预置服务列表
更新时间:2025-05-16
功能介绍
用于根据服务ID,获取预置服务列表。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 运维操作千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataOperateAccessPolicy
SDK调用
调用示例
1import os
2from qianfan import resources
3
4# 通过环境变量初始化认证信息
5# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9resp = resources.console.utils.call_action(
10 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
11 "/v2/service",
12 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
13 "DescribePresetServices",
14 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
15 {
16 "serviceIds": [ "svcp-7940ab471306"]
17 }
18)
19
20print(resp.body)
1package main
2
3import (
4 "context"
5 "fmt"
6 "os"
7
8 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
9)
10
11func main() {
12 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
13 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
14 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
15
16 ca := qianfan.NewConsoleAction()
17
18 res, err := ca.Call(context.TODO(),
19 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
20 "/v2/service",
21 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
22 "DescribePresetServices",
23 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
24 map[string]any{
25 "serviceIds": []string{"svcp-7940ab471306"},
26 })
27 if err != nil {
28 panic(err)
29 }
30 fmt.Println(string(res.Body))
31
32}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.console.ConsoleResponse;
3import com.baidubce.qianfan.util.CollUtils;
4import com.baidubce.qianfan.util.Json;
5import java.util.Map;
6
7public class Dome {
8 public static void main(String args[]){
9 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
11
12 ConsoleResponse<Map<String, Object>> response = qianfan.console()
13 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
14 .route("/v2/service")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DescribePresetServices")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21
22 ))
23 .execute();
24
25 System.out.println(Json.serialize(response));
26 }
27}
1import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7async function main() {
8 //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
9 //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
10 //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
11 const res = await consoleAction({
12 base_api_route: '/v2/service', action: 'DescribePresetServices', data: {
13 "serviceIds": [ "svcp-7940ab471306"]
14 }
15 });
16
17 console.log(res);
18}
19
20main();
返回示例
1{
2 "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
3 "result":{
4 "serviceList":[
5 {
6 "serviceId": "svcp-7940ab471306",
7 "name": "ERNIE-4.0-8K",
8 "url": "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions",
9 "endpoint":"ernie-x1-turbo-32k",
10 "serviceType": "chat",
11 "isPublic": True,
12 "modelSetId":"am-xxx",
13 "modelId":"amv-xxx",
14 "chargeType": "TPM",
15 "chargeStatus": "Opened",
16 "enableLogs": True,
17 "logStoreConfig": {
18 "logRegion": "bj",
19 "logProject": "default",
20 "logStoreName": "test02"
21 }
22 }
23 ]
24 }
25}
1{
2 "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
3 "result":{
4 "serviceList":[
5 {
6 "serviceId": "svcp-7940ab471306",
7 "name": "ERNIE-4.0-8K",
8 "url": "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions",
9 "endpoint":"ernie-x1-turbo-32k",
10 "serviceType": "chat",
11 "isPublic": true,
12 "modelSetId":"am-xxx",
13 "modelId":"amv-xxx",
14 "chargeType": "TPM",
15 "chargeStatus": "Opened",
16 "enableLogs": true,
17 "logStoreConfig": {
18 "logRegion": "bj",
19 "logProject": "default",
20 "logStoreName": "test02"
21 }
22 }
23 ]
24 }
25}
1{
2 "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
3 "result":{
4 "serviceList":[
5 {
6 "serviceId": "svcp-dywitgcxaq6j",
7 "name": "ERNIE-4.0-8K",
8 "url": "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions",
9 "endpoint":"ernie-x1-turbo-32k",
10 "serviceType": "chat",
11 "isPublic": true,
12 "modelSetId":"am-xxx",
13 "modelId":"amv-xxx",
14 "chargeType": "TPM",
15 "chargeStatus": "Opened",
16 "enableLogs": true,
17 "logStoreConfig": {
18 "logRegion": "bj",
19 "logProject": "default",
20 "logStoreName": "test02"
21 }
22 }
23 ]
24 }
25}
1{
2 requestId:'1bef3f87-c5b2-4419-936b-50f9884f10d4',
3 result:{
4 serviceList:[
5 {
6 serviceId: 'svcp-7940ab471306',
7 name: 'ERNIE-4.0-8K',
8 url: 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions'
9 endpoint:'ernie-x1-turbo-32k',
10 serviceType: 'chat',
11 isPublic: true,
12 modelSetId:'am-xxx',
13 modelId:'amv-xxx',
14 chargeType: 'TPM',
15 chargeStatus: 'Opened',
16 enableLogs: true,
17 logStoreConfig: {
18 logRegion: 'bj',
19 logProject: 'default',
20 logStoreName: 'test02'
21 }
22 }
23 ]
24 }
25}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
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:免费调用 |
protocolVersion | int | 否 | 服务协议版本,可选值如下: · 1,默认1 · 2 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
serviceList | List<object> | 服务列表 |
serviceList说明
名称 | 类型 | 描述 |
---|---|---|
serviceId | string | 服务ID |
name | string | 服务名称 |
url | string | 服务URL |
endpoint | string | 接入点 |
serviceType | string | 服务类型,说明: · chat · completions · text2image · image2text |
isPublic | bool | 是否是公共服务 |
modelSetId | string | 预置模型ID,为空表示无相关预置模型 |
modelId | string | 预置模型版本ID,为空表示无相关预置模型 |
model | string | 对应推理服务API V2的model参数值,当portocolVersion = 2时,返回该字段 |
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 |