获取定制服务列表
更新时间:2025-10-31
接口描述
本接口用于获取自定义服务列表。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 完全控制千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataFullControlAccessPolicy
- 运维操作千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataOperateAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
Bash
1POST /v2/service?Action=DescribeServices HTTP/1.1
2Host: qianfan.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
5
6{
7 "protocolVersion": 2
8}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称,固定值DescribeServices |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| 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 |
请求示例
Bash
1curl --location 'https://qianfan.baidubce.com/v2/service?Action=DescribeServices' \
2--header 'Authorization: bce-auth-v1/047ab2***3e28b1ac/2023-10-10T07:48:39Z/1800/host;x-bce-date/c26e0a219***10cb53f' \
3--header 'Content-Type: application/json' \
4--data '{
5 "protocolVersion": 2
6}'
响应示例
JSON
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}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
Plain Text
1{
2 "requestId":"6ba7b810-xxxc04fd430c8",
3 "code":"AccessDenied",
4 "message":"Access denied."
5}
更多错误码,请查看错误码说明。
