查询服务详情
更新时间：2026-09-21
该接口用于查询指定服务的详细配置，包括 Model 配置、后端策略、域名、消费者认证状态和 API 数量。
请求结构
Plain Text
1POST /?action=DescribeService HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "serviceId": serviceId
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| serviceId | String | 是 | RequestBody参数 | 服务 ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| serviceId | String | 服务 ID |
| instanceId | String | 网关实例 ID |
| serviceName | String | 服务名称 |
| serviceType | String | 服务类型：HTTP_SERVICE（HTTP 服务）/ MODEL_SERVICE（Model 服务）/ AGENT_SERVICE（Agent 服务） |
| modelScene | String | 模型场景：TEXT_GENERATION / IMAGE_GENERATION / OTHER / VIDEO_GENERATION / EMBEDDING / RERANK / AUDIO |
| modelProtocol | String | Model 服务协议：OPENAI_COMPATIBLE / ANTHROPIC_COMPATIBLE / QIANFAN / CUSTOM_HTTP / CUSTOM_WEBSOCKET / DOUBAO / BAILIAN / ORIGINAL |
| modelProtocolRoutes | List<ModelProtocolRoute> | Model 服务协议路由列表 |
| modelBasePath | String | Model 服务 basePath |
| modelBasePathStrip | Boolean | 转发时是否剥离 basePath |
| fallbackEnabled | Boolean | 是否启用 Fallback |
| fallbackFirstTokenTimeoutMs | int | Fallback 首 Token 超时时间，单位毫秒 |
| fallbackTriggerScope | String | Fallback 触发范围，目前仅支持 BACKEND_ERROR_ONLY |
| advancedPolicy | AiGwServiceAdvancedPolicyUO | Service 级默认高级策略，未配置时返回关闭状态的默认值 |
| modelBackends | List<AiGwApiBackendBindUO> | Model 服务默认路由的 upstream/fallback 后端绑定 |
| modelBackendStrategy | String | Model 服务默认路由后端分流策略：SINGLE / MODEL_NAME / WEIGHT |
| consumerAuthEnabled | Boolean | 是否开启消费者鉴权 |
| authorizationType | String | 鉴权类型 |
| apiCount | int | 服务下路由数量 |
| domainCount | long | 服务下绑定域名数量 |
| defaultPrivateDomain | String | 系统默认私网域名 |
| defaultPublicDomain | String | 系统默认公网域名 |
| domainIds | List<String> | 已绑定的自定义域名 ID 列表 |
| domains | List<ListAiGwServiceDomainUO> | 已绑定域名列表 |
| createTime | String | 创建时间 |
| updateTime | String | 更新时间 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: serviceId must not be blank | 400 | 必填参数缺失或格式不合法，serviceId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ServiceNotExist | Service not exist. | 404 | serviceId 对应的服务不存在、不属于当前账号或已删除 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribeService 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}返回示例
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 "serviceId": "svc-a1b2c3d4",
9 "instanceId": "gw-a1b2c3d4",
10 "serviceName": "对话服务",
11 "serviceType": "MODEL_SERVICE",
12 "modelScene": "TEXT_GENERATION",
13 "modelProtocol": "OPENAI_COMPATIBLE",
14 "modelProtocolRoutes": [
15 {
16 "id": "chat-completions",
17 "name": "对话补全",
18 "enabled": true,
19 "method": "POST",
20 "path": "/v1/chat/completions",
21 "matchType": "Exact",
22 "matchPath": "/v1/chat/completions"
23 }
24 ],
25 "modelBasePath": "/v1",
26 "modelBasePathStrip": false,
27 "fallbackEnabled": true,
28 "fallbackFirstTokenTimeoutMs": 3000,
29 "fallbackTriggerScope": "BACKEND_ERROR_ONLY",
30 "advancedPolicy": {
31 "timeout": true,
32 "timeoutTime": 30000,
33 "retries": true,
34 "attempts": 2,
35 "perTryTimeout": 5000,
36 "retryOn": ["5xx"],
37 "httpCodes": [502, 503]
38 },
39 "modelBackends": [
40 {
41 "backendId": "bd-a1b2c3d4",
42 "backendName": "主后端",
43 "matchType": null,
44 "matchContent": null,
45 "backendRole": "PRIMARY",
46 "weight": 10000,
47 "modelMatchType": null,
48 "modelMatchContent": null,
49 "fallbackOrder": null,
50 "backendType": "aiModel",
51 "backendTypeName": "AI 大模型"
52 }
53 ],
54 "modelBackendStrategy": "SINGLE",
55 "consumerAuthEnabled": false,
56 "authorizationType": null,
57 "apiCount": 1,
58 "domainCount": 1,
59 "defaultPrivateDomain": "svc-a1b2c3d4.internal.baidubce.com",
60 "defaultPublicDomain": "svc-a1b2c3d4.baidubce.com",
61 "domainIds": [
62 "dm-a1b2c3d4"
63 ],
64 "domains": [
65 {
66 "serviceDomainId": "dm-a1b2c3d4",
67 "domainName": "api.example.com",
68 "protocolType": "HTTPS",
69 "instanceId": "gw-a1b2c3d4",
70 "instanceName": "网关实例1",
71 "serviceId": "svc-a1b2c3d4",
72 "serviceName": "对话服务",
73 "domainType": "custom",
74 "updateTime": "2026-09-03T10:10:00Z"
75 }
76 ],
77 "createTime": "2026-09-01T08:00:00Z",
78 "updateTime": "2026-09-03T10:30:00Z"
79}评价此篇文章