获取定制服务列表
本接口用于获取自定义服务列表。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
完全控制千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataFullControlAccessPolicy
运维操作千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataOperateAccessPolicy
鉴权说明
调用本文API,使用"基于安全认证AK/SK"进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求参数
方法名称,固定值DescribeServices
本次查询的起始位置,默认从第一条数据开始
返回的列表长度,说明:
(1)最大为100,如果指定的值大于100,按100操作
(2)默认值是10
是否倒序,默认为false
服务名称,说明:填写此参数,表示根据服务名称模糊匹配进行筛选
服务类型,说明:
(1)填写此参数,表示按服务类型进行筛选
(2)可选值如下:
· chat
· completions
· text2image
· image2text
显示子属性
隐藏子属性
可选值: chat, completions, text2image, image2text
服务状态,说明:
(1)填写此参数,表示按进行筛选
(2)可选值:
· New:待发布
· Deploying:发布中
· Serving:已发布
· Failed:发布失败
· Stopped:暂停服务
显示子属性
隐藏子属性
可选值: New, Deploying, Serving, Failed, Stopped
创建人,说明:填写此参数,表示按创建人进行筛选
显示子属性
隐藏子属性
付费类型,说明:
(1)填写此参数,表示按付费类型进行筛选
(2)可选值如下:
· ComputingUnit:算力单元使用时长
· Tokens:Tokens调用量。
付费方式,说明:
(1)填写此参数,表示按付费方式进行筛选
(2)可选值:
· Prepay:预付费
· Postpay:后付费。
服务版本,可选值如下:
· 1,默认1
· 2。
POST /v2/service?Action=DescribeServices HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"protocolVersion": 2
}
示例代码
curl --location 'https://qianfan.baidubce.com/v2/service?Action=DescribeServices' \
--header 'Authorization: bce-auth-v1/047ab2***3e28b1ac/2023-10-10T07:48:39Z/1800/host;x-bce-date/c26e0a219***10cb53f' \
--header 'Content-Type: application/json' \
--data '{
"protocolVersion": 2
}'
返回响应
请求ID
请求结果
显示子属性
隐藏子属性
服务列表
显示子属性
隐藏子属性
显示子属性
隐藏子属性
服务ID
基础模型版本
模型ID
模型版本ID
服务名称
服务描述
服务URL
接入点
服务类型,说明:
· chat
· completions
· embeddings
· text2image
· image2text。
服务运行状态,说明:
· New: 待发布
· Deploying: 发布中
· Serving: 已发布
· Failed: 发布失败
· Stopped: 暂停服务。
更新状态,说明:
· None:无更新。
付费类型,说明:
· ComputingUnit: 算力单元使用时长
· Tokens: Tokens调用量。
付费方式,说明:
· Prepay: 预付费
· Postpay: 后付费
· Prepay,Postpay: 预付费+后付费。
付费状态,说明:
· NotOpen
· Opened
· Stopped
· Free。
资源配置
显示子属性
隐藏子属性
资源类型,说明:
· GPU-I-2:AI加速卡-I型-2算力单元
· GPU-I-4:AI加速卡-I型-4算力单元
· CPU-I-2:CPU-I型-2算力单元。
单副本QPS
购买副本数量
资源地域,说明:
· bj:北京
· bd:保定
· gz:广州
· su:苏州
· nj:南京。
部署配置
显示子属性
隐藏子属性
资源类型,具体值如下:
· GPU-I-2:AI加速卡-I型-2算力单元
· GPU-I-4:AI加速卡-I型-4算力单元
· CPU-I-2:CPU-I型-2算力单元。
资源地域,具体值如下:
· bj:北京
· bd:保定
· gz:广州
· su:苏州
· nj:南京。
单副本QPS
单副本算力单元数
部署副本总数
模型版本是否更新中
是否绑定日志投递
日志投递信息
显示子属性
隐藏子属性
日志集所在地域。当enableLogs为true时,显示logRegion
日志组名称。当enableLogs为true时,显示logProject
日志集名称。当enableLogs为true时,显示logStoreName
创建人
创建时间,格式: ISO 8601 date-time
服务版本
分页信息
显示子属性
隐藏子属性
本次查询的起始位置
请求返回的最大数目
指明是否只返回了部分数据,说明:
· false:表示本次已经返回所有结果
· true:表示本次还没有返回所有结果
当isTruncated为true时,才返回此项,作为下次查询marker的值
{
"requestId": "f3ce6afd-d60a-4232-85e0-74799ff131c0",
"result": {
"pageInfo": {
"marker": "",
"maxKeys": 100,
"isTruncated": false
},
"serviceList": [
{
"serviceId": "svco-mtigr**40c",
"baseModel": "BLOOMZ-7B",
"modelSetId": "am-8qh**vex",
"modelId": "amv-bafq**dcr",
"name": "api_test_v2",
"description": "",
"url": "https://qianfan.baidubce.com/v2/chat/completions",
"endpoint":"lq8z6*****",
"serviceType": "chat",
"runStatus": "New",
"scaleStatus": "None",
"updateStatus": "None",
"chargeType": "",
"payType": "",
"chargeStatus": "NotOpen",
"resourceConfig": {
"region": "bj",
"type": "GPU-1-1",
"replicasCount": 0,
"qps": 1
},
"isModelUpdating": false,
"enableLogs": false,
"logStoreConfig": {},
"creator": "百里**",
"createTime": "2024-07-30T05:45:46Z",
"deploymentConfig": {
"type": "GPU-1-1",
"region": "bj",
"qps": 1,
"replicasComputeUnitCount": 0,
"replicasCount": 0
},
"protocolVersion": 2
},
...
]
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
| 名称 | 描述 |
|---|---|
requestId |
请求ID |
code |
错误码 |
message |
错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。
