获取定制服务列表
更新时间:2025-07-28
功能介绍
用于获取自定义服务列表。
使用说明
本文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 "DescribeServices",
14 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
15 {
16 "protocolVersion": 2
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 "DescribeServices",
23 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
24 map[string]interface{}{
25 "protocolVersion": 2,
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("DescribeServices")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "protocolVersion",2
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({base_api_route: '/v2/service', action: 'DescribeServices', data: {
12 "protocolVersion": 2
13 }
14 });
15
16 console.log(res);
17}
18
19main();
返回示例
1{
2 "requestId": "f3ce6afd-d60a-4232-85e0-74799ff131c0",
3 "result": {
4 "pageInfo": {
5 "marker": "",
6 "maxKeys": 100,
7 "isTruncated": False
8 },
9 "serviceList": [
10 {
11 "serviceId": "svco-mtigr**40c",
12 "baseModel": "BLOOMZ-7B",
13 "modelSetId": "am-8qh**vex",
14 "modelId": "amv-bafq**dcr",
15 "name": "api_test_v2",
16 "description": "",
17 "url": "https://qianfan.baidubce.com/v2/chat/completions",
18 "endpoint":"lq8z6*****",
19 "serviceType": "chat",
20 "runStatus": "New",
21 "scaleStatus": "None",
22 "updateStatus": "None",
23 "chargeType": "",
24 "payType": "",
25 "chargeStatus": "NotOpen",
26 "resourceConfig": {
27 "region": "bj",
28 "type": "GPU-1-1",
29 "replicasCount": 0,
30 "qps": 1
31 },
32 "isModelUpdating": False,
33 "enableLogs": False,
34 "logStoreConfig": {},
35 "creator": "百里**",
36 "createTime": "2024-07-30T05:45:46Z",
37 "deploymentConfig": {
38 "type": "GPU-1-1",
39 "region": "bj",
40 "qps": 1,
41 "replicasComputeUnitCount": 0,
42 "replicasCount": 0
43 },
44 "protocolVersion": 2
45 },
46 ...
47 ]
48 }
49}
1{
2 "requestId": "f3ce6afd-d60a-4232-85e0-74799ff131c0",
3 "result": {
4 "pageInfo": {
5 "marker": "",
6 "maxKeys": 100,
7 "isTruncated": false
8 },
9 "serviceList": [
10 {
11 "serviceId": "svco-mtigr**40c",
12 "baseModel": "BLOOMZ-7B",
13 "modelSetId": "am-8qh**vex",
14 "modelId": "amv-bafq**dcr",
15 "name": "api_test_v2",
16 "description": "",
17 "url": "https://qianfan.baidubce.com/v2/chat/completions",
18 "endpoint":"lq8z6*****",
19 "serviceType": "chat",
20 "runStatus": "New",
21 "scaleStatus": "None",
22 "updateStatus": "None",
23 "chargeType": "",
24 "payType": "",
25 "chargeStatus": "NotOpen",
26 "resourceConfig": {
27 "region": "bj",
28 "type": "GPU-1-1",
29 "replicasCount": 0,
30 "qps": 1
31 },
32 "isModelUpdating": false,
33 "enableLogs": false,
34 "logStoreConfig": {},
35 "creator": "百里**",
36 "createTime": "2024-07-30T05:45:46Z",
37 "deploymentConfig": {
38 "type": "GPU-1-1",
39 "region": "bj",
40 "qps": 1,
41 "replicasComputeUnitCount": 0,
42 "replicasCount": 0
43 },
44 "protocolVersion": 2
45 },
46 ...
47 ]
48 }
49}
1{
2 "requestId": "f3ce6afd-d60a-4232-85e0-74799ff131c0",
3 "result": {
4 "pageInfo": {
5 "marker": "",
6 "maxKeys": 100,
7 "isTruncated": false
8 },
9 "serviceList": [
10 {
11 "serviceId": "svco-mtigr**40c",
12 "baseModel": "BLOOMZ-7B",
13 "modelSetId": "am-8qh**vex",
14 "modelId": "amv-bafq**dcr",
15 "name": "api_test_v2",
16 "description": "",
17 "url": "https://qianfan.baidubce.com/v2/chat/completions",
18 "endpoint":"lq8z6*****",
19 "serviceType": "chat",
20 "runStatus": "New",
21 "scaleStatus": "None",
22 "updateStatus": "None",
23 "chargeType": "",
24 "payType": "",
25 "chargeStatus": "NotOpen",
26 "resourceConfig": {
27 "region": "bj",
28 "type": "GPU-1-1",
29 "replicasCount": 0,
30 "qps": 1
31 },
32 "isModelUpdating": false,
33 "enableLogs": false,
34 "logStoreConfig": {},
35 "creator": "百里**",
36 "createTime": "2024-07-30T05:45:46Z",
37 "deploymentConfig": {
38 "type": "GPU-1-1",
39 "region": "bj",
40 "qps": 1,
41 "replicasComputeUnitCount": 0,
42 "replicasCount": 0
43 },
44 "protocolVersion": 2
45 },
46 ...
47 ]
48 }
49}
1{
2 requestId: 'f3ce6afd-d60a-4232-85e0-74799ff131c0',
3 result: {
4 pageInfo: {
5 marker: '',
6 maxKeys: 100,
7 isTruncated: false
8 },
9 serviceList: [
10 {
11 serviceId: 'svco-mtigr**40c',
12 baseModel: 'BLOOMZ-7B',
13 modelSetId: 'am-8qh**vex',
14 modelId: 'amv-bafq**dcr',
15 name: 'api_test_v2',
16 description: '',
17 url: 'https://qianfan.baidubce.com/v2/chat/completions',
18 endpoint:'lq8z6*****',
19 serviceType: 'chat',
20 runStatus: 'New',
21 scaleStatus: 'None',
22 updateStatus: 'None',
23 chargeType: '',
24 payType: '',
25 chargeStatus: 'NotOpen',
26 resourceConfig: {
27 region: 'bj',
28 type: 'GPU-1-1',
29 replicasCount: 0,
30 qps: 1
31 },
32 isModelUpdating: false,
33 enableLogs: false,
34 logStoreConfig: {},
35 creator: '百里**',
36 createTime: '2024-07-30T05:45:46Z',
37 deploymentConfig: {
38 type: 'GPU-1-1',
39 region: 'bj',
40 qps: 1,
41 replicasComputeUnitCount: 0,
42 replicasCount: 0
43 },
44 protocolVersion: 2
45 },
46 ...
47 ]
48 }
49}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
marker | string | 否 | 本次查询的起始位置,默认从第一条数据开始 |
maxKeys | int | 否 | 返回的列表长度,说明: (1)最大为100,如果指定的值大于100,按100操作 (2)默认值是10 |
pageReverse | bool | 否 | 是否倒序,默认为false |
name | string | 否 | 服务名称,说明:填写此参数,表示根据服务名称模糊匹配进行筛选 |
serviceType | List<string> | 否 | 服务类型,说明: (1)填写此参数,表示按服务类型进行筛选 (2)可选值如下: · chat · completions · text2image · image2text |
runStatus | List<string> | 否 | 服务状态,说明: (1)填写此参数,表示按进行筛选 (2)可选值: · New:待发布 · Deploying:发布中 · Serving:已发布 · Failed:发布失败 · Stopped:暂停服务 |
creator | List<string> | 否 | 创建人,说明:填写此参数,表示按创建人进行筛选 |
chargeType | string | 否 | 付费类型,说明: (1)填写此参数,表示按付费类型进行筛选 (2)可选值如下: · ComputingUnit:算力单元使用时长 · Tokens:Tokens调用量 |
payType | string | 否 | 付费方式,说明: (1)填写此参数,表示按付费方式进行筛选 (2)可选值: · Prepay:预付费 · Postpay:后付费 |
protocolVersion | int | 否 | 服务版本,可选值如下: · 1,默认1 · 2 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
serviceList | List<object> | 服务列表 |
pageInfo | object | 分页信息 |
serviceList说明
名称 | 类型 | 描述 |
---|---|---|
serviceId | string | 服务ID |
baseModel | string | 基础模型版本 |
modelSetId | string | 模型ID |
modelId | string | 模型版本ID |
name | string | 服务名称 |
description | string | 服务描述 |
url | string | 服务URL |
endpoint | string | 接入点 |
serviceType | string | 服务类型,说明: · chat · completions · embeddings · text2image · image2text |
runStatus | string | 服务运行状态,说明: · New: 待发布 · Deploying: 发布中 · Serving: 已发布 · Failed: 发布失败 · Stopped: 暂停服务 |
updateStatus | string | 更新状态,说明: · None:无更新 |
chargeType | string | 付费类型,说明: · ComputingUnit: 算力单元使用时长 · Tokens: Tokens调用量 |
payType | string | 付费方式,说明: · Prepay: 预付费 · Postpay: 后付费 · Prepay,Postpay: 预付费+后付费 |
chargeStatus | string | 付费状态,说明: · NotOpen · Opened · Stopped · Free |
resourceConfig | object | 资源配置 |
deploymentConfig | object | 部署配置 |
isModelUpdating | bool | 模型版本是否更新中 |
enableLogs | bool | 是否绑定日志投递 |
logStoreConfig | object | 日志投递信息 |
creator | string | 创建人 |
createTime | string | 创建时间 |
protocolVersion | int | 服务版本 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置 |
maxKeys | int | 请求返回的最大数目 |
isTruncated | bool | 指明是否只返回了部分数据,说明: · false:表示本次已经返回所有结果 · true:表示本次还没有返回所有结果 |
nextMarker | string | 当isTruncated为true时,才返回此项,作为下次查询marker的值 |
resourceConfig说明
名称 | 类型 | 描述 |
---|---|---|
type | string | 资源类型,说明: · GPU-I-2:AI加速卡-I型-2算力单元 · GPU-I-4:AI加速卡-I型-4算力单元 · CPU-I-2:CPU-I型-2算力单元 |
qps | float | 单副本QPS |
replicasCount | int | 购买副本数量 |
region | string | 资源地域,说明: · bj:北京 · bd:保定 · gz:广州 · su:苏州 · nj:南京 |
deploymentConfig说明
名称 | 类型 | 描述 |
---|---|---|
type | string | 资源类型,具体值如下: · GPU-I-2:AI加速卡-I型-2算力单元 · GPU-I-4:AI加速卡-I型-4算力单元 · CPU-I-2:CPU-I型-2算力单元 |
region | string | 资源地域,具体值如下: · bj:北京 · bd:保定 · gz:广州 · su:苏州 · nj:南京 |
qps | float | 单副本QPS |
replicasComputeUnitCount | int | 单副本算力单元数 |
replicasCount | int | 部署副本总数 |
logStoreConfig说明
名称 | 类型 | 描述 |
---|---|---|
logRegion | string | 日志集所在地域。当enableLogs为True时,显示logRegion |
logProject | string | 日志组名称。当enableLogs为True时,显示logProject |
logStoreName | string | 日志集名称。当enableLogs为True时,显示logStoreName |