获取服务列表
更新时间:2024-03-28
功能介绍
本接口用于获取自定义服务列表。
注意事项
- 调用本文API,使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权,无法使用获取Access Token的方式鉴权,具体鉴权认证机制参考鉴权认证机制。
请求说明
基本信息
请求地址: 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 | 是 | 方法名称,固定值DescribeServices |
Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
marker | string | 否 | 本次查询的起始位置,默认从第一条数据开始 |
maxKeys | int | 否 | 返回的列表长度,说明: (1)最大为100,如果指定的值大于100,按100操作 (2)默认值是10 |
pageReverse | bool | 否 | 是否倒序,默认为false |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
serviceList | List |
服务列表 |
pageInfo | object | 分页信息 |
serviceItem说明
名称 | 类型 | 描述 |
---|---|---|
serviceId | string | 服务ID |
modelId | string | 模型ID |
modelVersionId | string | 模型版本ID |
name | string | 服务名称 |
description | string | 服务描述 |
url | string | 服务URL |
serviceType | string | 服务类型,说明: · chat · completions · embeddings · text2image · image2text |
runStatus | string | 服务运行状态,说明: · New: 待发布 · Deploying: 发布中 · Serving: 已发布 · Failed: 发布失败 · Stopped: 暂停服务 |
chargeStatus | string | 付费状态,说明: · NOTOPEN · OPENED · STOP · FREE |
resourceConfig | object | 资源配置 |
createTime | string | 创建时间 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置 |
maxKeys | int | 请求返回的最大数目 |
isTruncated | bool | 指明是否只返回了部分数据,说明: · false:表示本次已经返回所有结果 · true:表示本次还没有返回所有结果 |
nextMarker | string | 当isTruncated为true时,才返回此项,作为下次查询marker的值 |
示例
请求示例
curl --location 'https://qianfan.baidubce.com/v2/service?Action=DescribeServices' \
--header 'Authorization: bce-auth-v1/047ab241bad24166b42a4d2e3e28b1ac/2023-10-10T07:48:39Z/1800/host;x-bce-date/c26e0a21944cxxxxxe2f2d10cb53f' \
--header 'x-bce-date: 2023-10-10T07:48:17Z' \
--header 'Content-Type: application/json' \
--data '{
"marker":"svco-n50985crhqq3"
}'
请求示例
响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"serviceList":[
{
"serviceId": "svco-dywitgcxaq6j",
"modelId": "am-jbxxx16x14",
"modelVersionId": "amv-0590vxxxd6d6",
"name": "yige",
"description": "ttt",
"url": "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/text2image/xxxx",
"serviceType": "text2image",
"runStatus": "Serving",
"chargeStatus": "OPENED",
"resourceConfig":{
"type": "GPU-I-2",
"replicasCount": 1,
"qps": 10
},
"createTime": "2024-01-08T15:29:27Z"
}
],
"pageInfo":{
"marker":"svco-n50985crhqq3",
"maxKeys":1,
"isTruncated":false
}
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如Access Token失效返回:
{
"error_code": 110,
"error_msg": "Access token invalid or no longer valid"
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。