创建服务
更新时间:2024-03-28
功能介绍
本接口用于创建服务。
注意事项
- 调用本文API,使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权,无法使用获取Access Token的方式鉴权,具体鉴权认证机制参考鉴权认证机制。
请求说明
基本信息
请求地址: https://qianfan.baidubce.com/wenxinworkshop/service/apply
请求方式: POST
Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 否 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
modelId | int | 是 | 模型ID,说明: (1)当前参数modelId仅支持int类型,即之前使用获取的模版ID为int类型,如下图所示: (2)当前通过千帆控制台新创建的模型ID为string类型,暂不支持,后续将支持 |
modelVersionId | int | 是 | 模型版本id,说明: (1)当前参数modelVersionId仅支持int类型,即之前使用以下方式获取的int值: (2)当前通过千帆控制台新创建的模型版本ID为string类型,暂不支持,后续将支持 |
name | string | 是 | 服务名称,字符串长度为 [2, 20] |
uri | string | 是 | 服务URI,字符串长度为 [2, 20] |
replicas | int | 是 | 副本数,设置多副本可提高服务性能 |
poolType | int | 是 | 资源池类型,可选值如下: 2:私有资源池,默认值为2 1:公有资源池,只有ernieBotLite-v200-ptuning模型支持公有资源池,返回该字段 |
description | string | 否 | 服务描述,字符串长度为 [0, 500] |
响应说明
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
result | bool | 创建服务结果,说明: true:成功 false:失败 |
serviceId | int | 创建的服务的ID |
示例
请求示例
# 替换下列示例中的Authorization、x-bce-date
curl --location 'https://qianfan.baidubce.com/wenxinworkshop/service/apply' \
--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 '{
"description": "",
"modelVersionId": 428,
"name": "api测试",
"uri": "apitest",
"modelId": 312,
"poolType": 2,
"replicas": 1
}'
响应示例
{
"log_id": "2771697584",
"result": {
"result": true,
"serviceId": 164
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如参数错误返回:
{
"error_code": 500001,
"error_msg": "param invalid"
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。