预览服务变更
更新时间：2026-09-21
该接口用于校验服务编辑参数，并预览受影响默认 Model 路由的当前值、目标值、流量变化类型及是否需要下发数据面。
注意事项：
- 该接口为只读操作，不修改控制面数据，也不刷新数据面配置。
请求结构
Plain Text
1POST /?action=PreviewUpdateService HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "serviceId": serviceId,
7 "serviceName": serviceName,
8 "serviceType": serviceType,
9 "modelScene": modelScene,
10 "modelProtocol": modelProtocol,
11 "modelProtocolRoutes" : [modelProtocolRoute],
12 "modelBasePath": modelBasePath,
13 "modelBasePathStrip": modelBasePathStrip,
14 "modelBackends" : [modelBackend],
15 "modelBackendStrategy": modelBackendStrategy,
16 "fallbackEnabled": fallbackEnabled,
17 "fallbackFirstTokenTimeoutMs": fallbackFirstTokenTimeoutMs,
18 "fallbackTriggerScope": fallbackTriggerScope,
19 "advancedPolicy": {
20 "timeout": timeout,
21 "timeoutTime": timeoutTime,
22 "retries": retries,
23 "attempts": attempts,
24 "perTryTimeout": perTryTimeout,
25 "retryOn" : [retryOn],
26 "httpCodes" : [httpCode]
27 },
28 "domainIds" : [domainId]
29}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| serviceId | String | 是 | RequestBody参数 | 服务 ID |
| serviceName | String | 是 | RequestBody参数 | 服务名称 |
| serviceType | String | 否 | RequestBody参数 | 服务类型：HTTP_SERVICE（HTTP 服务）/ MODEL_SERVICE（Model 服务）/ AGENT_SERVICE（Agent 服务） |
| modelScene | String | 否 | RequestBody参数 | 模型场景：TEXT_GENERATION / IMAGE_GENERATION / OTHER / VIDEO_GENERATION / EMBEDDING / RERANK / AUDIO，仅 MODEL_SERVICE 时生效 |
| modelProtocol | String | 否 | RequestBody参数 | Model 服务协议：OPENAI_COMPATIBLE / ANTHROPIC_COMPATIBLE / QIANFAN / CUSTOM_HTTP / CUSTOM_WEBSOCKET / DOUBAO / BAILIAN / ORIGINAL，仅 MODEL_SERVICE 时生效 |
| modelProtocolRoutes | List<ModelProtocolRouteReq> | 否 | RequestBody参数 | Model 服务协议路由列表 |
| modelBasePath | String | 否 | RequestBody参数 | Model 服务 basePath |
| modelBasePathStrip | Boolean | 否 | RequestBody参数 | 转发时是否剥离 basePath |
| modelBackends | List<ModelBackendBindReq> | 否 | RequestBody参数 | Model 服务默认路由的 upstream/fallback 后端绑定 |
| modelBackendStrategy | String | 否 | RequestBody参数 | Model 服务默认路由后端分流策略：SINGLE / MODEL_NAME / WEIGHT |
| fallbackEnabled | Boolean | 否 | RequestBody参数 | 是否启用 Fallback |
| fallbackFirstTokenTimeoutMs | int | 否 | RequestBody参数 | Fallback 首 Token 超时时间，单位毫秒，取值不小于 0 |
| fallbackTriggerScope | String | 否 | RequestBody参数 | Fallback 触发范围，目前仅支持 BACKEND_ERROR_ONLY |
| advancedPolicy | AdvancedPolicyReq | 否 | RequestBody参数 | Service 级默认高级策略，仅 MODEL_SERVICE 支持；不传表示不修改，传空对象表示清空 |
| domainIds | List<String> | 否 | RequestBody参数 | 更新时指定的自定义域名 ID 列表；null 表示保持不变，空列表表示解绑全部自定义域名（系统默认域名保留） |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| advancedPolicy | AiGwServiceAdvancedPolicyUO | Service 级默认高级策略，未配置时返回关闭状态的默认值 |
| previews | List<AiGwRouteChangePreviewUO> | 路由变更预览列表 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: serviceName must not be blank | 400 | 必填参数缺失或格式不合法，serviceId、serviceName 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ServiceNotExist | Service not exist. | 404 | serviceId 对应的服务不存在、不属于当前账号或已删除 |
| DomainNotExist | Domain not exist. | 404 | domainIds 中存在不存在、不属于当前账号或已绑定其它服务的域名 |
| BackendNotExist | Backend not exist. | 404 | modelBackends 中存在不存在或不属于当前实例的后端 |
| ServiceNameRepeatedException | Service name repeated. | 413 | 同一实例下服务名称已被占用 |
| ParamCheckError | Invalid model backend strategy. | 413 | 服务配置校验不通过，如后端分流策略、Fallback 参数或高级策略取值不合法 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
请求示例
Plain Text
1POST /?action=PreviewUpdateService HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "serviceId": "svc-a1b2c3d4",
7 "serviceName": "对话服务",
8 "modelBackendStrategy": "MODEL_NAME",
9 "modelBackends": [
10 {
11 "backendId": "bd-a1b2c3d4",
12 "backendRole": "PRIMARY",
13 "modelMatchContent": "gpt-4*"
14 }
15 ]
16}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "advancedPolicy": {
9 "timeout": true,
10 "timeoutTime": 30000,
11 "retries": true,
12 "attempts": 2,
13 "perTryTimeout": 5000,
14 "retryOn": ["5xx"],
15 "httpCodes": [502, 503]
16 },
17 "previews": [
18 {
19 "apiId": "api-a1b2c3d4",
20 "serviceId": "svc-a1b2c3d4",
21 "routeName": "默认模型路由",
22 "routeSource": "MODEL_SERVICE_MODEL_NAME",
23 "publishStatus": "PUBLISHED",
24 "currentPath": "/v1/chat/completions",
25 "targetPath": "/v1/chat/completions",
26 "currentUrlRewrite": false,
27 "targetUrlRewrite": false,
28 "currentUrlRewritePath": null,
29 "targetUrlRewritePath": null,
30 "currentUrlRewriteHost": null,
31 "targetUrlRewriteHost": null,
32 "trafficChangeType": "ADD",
33 "willPublish": true
34 }
35 ]
36}评价此篇文章