查询服务详情

更新时间：2024-09-23

注意：

为提升开发者使用体验，推荐使用模型服务V2版本接口，功能更全面、且接口更规范，详见模型服务API列表。
模型服务V1版本接口功能不再升级，本文档于2024年8月5日下线；由于V1版本接口后续可能下线停止服务，为避免影响使用，建议接入模型服务V2版本接口。

功能介绍

本接口用于根据服务版本id查询服务详情，如模型id，模型类型，数据集模版类型、服务名称、版本号等。

SDK调用

使用说明

调用本文API，需使用安全认证AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。

调用示例

Python

import os
from qianfan import resources

# 使用安全认证AK/SK鉴权，通过环境变量方式初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"

svc = resources.Service.get(id = 2047)
print(svc)

返回示例

Python

QfResponse(code = 200, headers = {...
}, body = {
    'log_id': '3238730871',
    'result='
    {
        'id': 199,
        'aiModelId': 370,
        'aiModelVersionId': 507,
        'name': 'yige',
        'uri': 'a0cxxxxx',
        'url': 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/text2image/a0cxxxxx',
        'serviceStatus': 'Failed',
        'onlineTime': '0000-00-00 00:00:00',
        'createTime': '2024-01-08 15:29:27'
    }
}
})

请求参数

名称	类型	必填	描述
id	int	是	服务版本id，可以通过以下方法获取该字段值：方式一：通过调用创建服务接口，返回参数serviceId获取方式二：通过页面url地址获取，在控制台-在线服务-我的服务页面，点击某服务详情，在页面url地址中查看，如下图所示

返回参数

名称	类型	描述
log_id	string	请求ID
result	dict	请求结果

result说明

名称	类型	描述
id	int	服务版本id
aiModelId	int	模型id
aiModelVersionId	int	模型版本id
name	string	服务名称
uri	string	服务uri
url	string	服务url
serviceStatus	string	服务状态，说明： Done：已发布 New：待发布 Deploying：发布中 Failed：发布失败 Stopped：暂停服务
onlineTime	string	上线时间戳
createTime	string	创建时间戳

HTTP调用

鉴权说明

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

请求说明

基本信息

请求地址： https://qianfan.baidubce.com/wenxinworkshop/service/detail

请求方式： POST

Header参数

名称	类型	必填	描述
Content-Type	string	是	固定值：application/json
x-bce-date	string	否	当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z
Authorization	string	是	用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具

Body参数

名称	类型	必填	描述
serviceId	int	是	服务版本id，可以通过以下任一方式获取：方式一：通过调用接口创建服务，返回参数serviceId获取方式二：通过控制台-在线服务-我的服务页面，点击某服务详情，在页面url地址中查看，如下图所示：

响应说明

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

result说明

名称	类型	描述
id	int	服务版本id
aiModelId	int	模型id
aiModelVersionId	int	模型版本id
name	string	服务名称
uri	string	服务uri
url	string	服务url
serviceStatus	string	服务状态，说明： · Done: 已发布 · New: 待发布 · Deploying: 发布中 · Failed: 发布失败 · Stopped: 暂停服务
onlineTime	string	上线时间
createTime	string	创建时间

请求示例

bash

# 替换下列示例中的Authorization、x-bce-date
curl --location 'https://qianfan.baidubce.com/wenxinworkshop/service/detail' \
--header 'Authorization: bce-auth-v1/047ab24xxxxx/2023-10-11T11:46:08Z/18000/host;x-bce-date/d06b075b2a963f381e6xxxxxx' \
--header 'x-bce-date: 2023-10-11T11:45:35Z' \
--header 'Content-Type: application/json' \
--data '{
    "serviceId":250
}'

响应示例

JSON

{
    "log_id": "2912873593",
    "result": {
        "id": 250,
        "aiModelId": 491,
        "aiModelVersionId": 684,
        "name": "yige",
        "uri": "a0cj0hci_yige_v1",
        "url": "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/text2image/a0cj0hci_yige_v1",
        "serviceStatus": "Failed",
        "onlineTime": "0000-00-00 00:00:00",
        "createTime": "2024-01-08 15:29:27"
    }
}

错误码

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

名称	描述
error_code	错误码
error_msg	错误描述信息，帮助理解和解决发生的错误

例如参数错误返回：

{
  "error_code": 500001,
  "error_msg": "param invalid"
}

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

百度智能云

百度智能云千帆大模型服务与开发平台ModelBuilder