获取定制服务详情

更新时间：2025-01-21

接口描述

本接口用于获取服务详情。

权限说明

调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：

完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
运维操作千帆大模型平台预测服务的权限：QianfanServiceOperateAccessPolicy
只读访问千帆大模型平台预测服务的权限：QianfanServiceReadAccessPolicy

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求结构

Bash

POST /v2/service?Action=DescribeService HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "serviceId":"svco-nzxxxxx4h"
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

Query参数

名称	类型	必填	描述
Action	string	是	方法名称，固定值DescribeService

Body参数

名称	类型	必填	描述
serviceId	string	是	服务ID，可以通过任一方式获取：方式一：通过调用接口创建服务，返回参数serviceId获取方式二：通过控制台-在线服务-我的服务页面，点击某服务详情查看，如下图所示：
protocolVersion	int	否	服务版本，可选值如下： · 1，默认1 · 2

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
requestId	string	请求ID
result	object	请求结果

result说明

名称	类型	描述
serviceId	string	服务ID
baseModel	string	基础模型版本
modelSetId	string	模型ID
modelId	string	模型版本ID
name	string	服务名称
description	string	服务描述
url	string	服务URL
serviceType	string	服务类型
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 · Free
resourceConfig	object	资源配置
deploymentConfig	object	部署配置
isModelUpdating	bool	模型版本是否更新中
enableLogs	bool	是否绑定日志投递
logStoreConfig	object	日志投递信息
creator	string	创建人
createTime	string	创建时间
protocolVersion	int	服务版本
urlSuffix	string	url后缀，说明：（1）只有在请求参数protocolVersion=2时，返回该参数（2）该参数用在调用推理服务V2接口，针对平台训练调用API，此参数为model值

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	部署副本总数
deploymentComputeUnitList	List<deploymentComputeUnit>	部署使用算力单元列表

deploymentComputeUnit说明

名称	类型	描述
instanceId	string	算力单元实例ID
deploymentReplicasCount	Int	部署副本数
deploymentComputingUnits	Int	部署使用算力单元数，等于单副本算力单元数*部署副本数
status	string	资源状态
paymentTiming	string	付费类型，具体值如下： · Prepaid：预付费 · Postpaid：表示后付费
expiredTime	string	算力单元实例的到期时间

logStoreConfig说明

名称	类型	描述
logRegion	string	日志集所在地域。当enableLogs为true，显示logRegion
logProject	string	日志组名称。当enableLogs为true，显示logProject
logStoreName	string	日志集名称。当enableLogs为true，显示logStoreName

请求示例

Bash

curl --location 'https://qianfan.baidubce.com/v2/service?Action=DescribeService' \
--header 'Authorization: bce-auth-v1/047ab241bad24166b42a4d2e3e28b1ac/2024-01-10T08:39:09Z/180000/host;x-bce-date/eae9855604c2e3xxxxxa3f0a7318bb94f17f7e03cfcbaff' \
--header 'Content-Type: application/json' \
--data '{
    "serviceId":"svco-nzxxxxx4h"
}'

响应示例

JSON

{
    "requestId": "93c46f79-525a-45af-9d1d-b59c70f3ebcd",
    "result": {
        "serviceId": "svco-nzxxxx4h",
        "baseModel": "CodeLlama-7B",
        "modelSetId": "am-gbxxxxpvb",
        "modelId": "amv-9jxxxxx5m4",
        "name": "lf_postp***",
        "description": "lf_postpay",
        "url": "http://as***",
        "serviceType": "chat",
        "runStatus": "New",
        "scaleStatus": "None",
        "updateStatus": "None",
        "chargeType": "",
        "payType": "",
        "chargeStatus": "NotOpen",
        "resourceConfig": {
            "region": "bd",
            "type": "GPU-1-1",
            "replicasCount": 0,
            "qps": 3
        },
        "isModelUpdating": false,
        "enableLogs": false,
        "logStoreConfig": {},
        "creator": "百里**",
        "createTime": "2024-12-24T09:32:54Z",
        "deploymentConfig": {
            "type": "GPU-1-1",
            "region": "bd",
            "qps": 3,
            "replicasComputeUnitCount": 0,
            "replicasCount": 0
        },
        "protocolVersion": 1
    }
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
requestId	请求ID
code	错误码
message	错误描述信息，帮助理解和解决发生的错误

例如错误返回：

{
    "requestId":"6ba7b810-xxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多相关错误码，请查看错误码说明。

获取定制服务列表

查询服务调用情况

百度智能云

千帆大模型服务与开发平台ModelBuilder