创建定制服务
更新时间：2024-11-14
功能介绍
本接口用于创建服务。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 管理员权限：QianfanFullControlAccessPolicy
- 模型服务运维权限：QianfanServiceOperateAccessPolicy
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址： 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 | 是 | 方法名称，固定值CreateService |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| modelSetId | string | 是 | 模型ID，示例：am-gh0azfeb9adu，说明： 通过以下方法获取该字段值：在控制台-我的模型查看，如下图所示  |
| modelId | string | 是 | 模型版本ID，示例：amv-g73j3faikzpz，说明： 通过以下方式获取该字段值： · 方式一，通过调用获取模型详情接口，返回的modelVersionIdStr字段获取 · 方式二，在控制台-我的模型-点击某模型详情，在版本列表中查看  |
| name | string | 是 | 服务名称，说明： 取值范围：字符串长度为 [2, 20] |
| description | string | 否 | 服务描述，说明： 取值范围：字符串长度为 [0, 500] |
| urlSuffix | string | 是 | 服务URL后缀，说明： （1）取值范围：字符串长度为 [2, 20] （2）字符规则：支持小写英文字母、数字、下划线（_）、短横线（-），首尾必须为字母或数字 |
| resourceConfig | object | 是 | 资源配置，说明： （1）付费资源类型为Tokens，即chargeType=Tokens时，该字段非必填 |
| billing | object | 是 | 订单、计费相关参数 |
resourceConfig说明
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| region | string | 否 | 资源地域，说明： （1）如果不填写该字段，系统默认获取满足资源的region （2）如果填写该字段，可选值如下： · bj：北京 · bd：保定 |
| type | string | 否 | 资源类型，说明： （1）可选值如下： · CPU I型：CPU-1-1 · 加速卡I型：GPU-1-1、GPU-1-2、GPU-1-4、GPU-1-8 · 加速卡V型：GPU-5-1、GPU-5-2 · 加速卡VI型：GPU-6-1、GPU-6-2 · 加速卡VII型：GPU-7-1、GPU-7-2 （2）付费资源类型为ComputingUnit，即chargeType=ComputingUnit时，该字段必填 |
| qps | float | 否 | 单副本QPS，说明： （1）不填此字段，默认使用模型预估QPS （2）取值范围：(0, 50]，精确到0.01 |
| replicasCount | int | 是 | 购买副本数量 |
billing说明
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| paymentTiming | string | 是 | 付费类型，可选值： · Prepaid：预付费 · Postpaid: 后付费 |
| reservation | object | 否 | 保留信息，说明： （1）只有当付费类型为预付费，即paymentTiming值为Prepaid时，该字段必填 （2）付费类型为后付费，无需填写此参数 |
| chargeType | string | 否 | 付费资源类型，说明： （1）只有当付费类型为后付费，即paymentTiming值为Postpaid时，该字段必填，可选值如下： · ComputingUnit：算力单元，默认值为ComputingUnit · Tokens：Tokens消耗量 （2）付费类型为预付费，无需填写此参数 |
| releaseTime | string | 否 | 定时释放时间，说明： （1）只有当付费类型为后付费，即paymentTiming值为Postpaid时，该字段有效 （2）支持RFC3339格式和标准格式，如 2030-01-25T12:30:30+08:00、2030-01-25 12:30:30 |
**reservation说明**
| 名称 | 类型 | 必填 | 描述 |
| ------------------- | ------ | ---- | ----------------------- |
| reservationTimeUnit | string | 是 | 时间单位，可选值：<br>· Month: 月 |
| reservationLength | int | 是 | 购买时长，说明：<br>· 时间单位为月，取值范围 [1-12] |
| autoRenew | boolean | 否 | 是否自动续费，可选值：<br>· true：是 <br>· false：否，默认值为false |
| autoRenewTimeUnit | String | 否 | 自动续费周期时间单位，默认值为month，可选值：<br>· month：月 |
| autoRenewTime | int | 否 | 自动续费时长，说明：<br>（1）单位：月 <br>（2）默认值为1，取值范围：[1,6] |
### 响应说明
| 名称 |类型 |描述 |
| --- | --- | --- |
| requestId | string | 请求ID |
| result | object | 请求结果 |
**result说明**
| 名称 |类型 |描述 |
| --- | --- | --- |
| serviceId | string | 服务ID |
| instanceId | string | 实例ID |
### 请求示例
~~~codeset
```bash label=Bash
curl --location 'https://qianfan.baidubce.com/v2/service?Action=CreateService' \
--header 'Authorization: bce-auth-v1/047ab241bad24166b42a4d2e3e28b1ac/2024-01-10T08:39:09Z/180000/host;x-bce-date/817d842c4243xxxxx818f0e1a93304cb01' \
--header 'x-bce-date: 2024-01-10T08:37:40Z' \
--header 'Content-Type: application/json' \
--data '{
"modelSetId": "am-jb0kzci16x14",
"modelId": "amv-0590vsgisd6d",
"name": "api测试",
"description": "",
"urlSuffix": "apitest",
"resourceConfig": {
"region":"bj",
"type": "GPU-1-1",
"qps": 10,
"replicasCount": 2
},
"billing":{
"paymentTiming":"Prepaid",
"reservation":{
"reservationTimeUnit":"Month",
"reservationLength":1
}
}
}'
```
~~~
### 响应示例
~~~codeset
```json label=JSON
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"serviceId": "svco-dywitxxxxaq6j",
"instanceId":"44961088xxxx539e9379f5daf"
}
}
```
~~~
## SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考[创建定制服务](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Ylxe2aygb)。
## 错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 |描述 |
| --- | --- |
|requestId | 请求ID |
|code | 错误码 |
|message |错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
```
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
```
更多相关错误码，请查看[错误码说明](https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Wlyckvrz8)。