开启OTel链路追踪
更新时间:2026-09-20
该接口用于为指定 AI 网关实例开启 OpenTelemetry 链路追踪,并将链路数据上报至 BCM APM。
注意事项:
- 调用前需先创建 APM 实例并等待其进入
RUNNING状态;本接口不会创建或轮询 APM 实例。 otelConfig.enableOtel必须为true,otelSamplingPercentage取值范围为 0~100。- 已开启 OTel 的实例不能重复开启。
请求结构
Plain Text
1POST /?action=OpenOtel HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "instanceId": instanceId,
7 "otelConfig": {
8 "enableOtel": enableOtel,
9 "otelCollectorReplicas": otelCollectorReplicas,
10 "otelCollectorReqCpu": otelCollectorReqCpu,
11 "otelCollectorReqMem": otelCollectorReqMem,
12 "otelCollectorMaxCpu": otelCollectorMaxCpu,
13 "otelCollectorMaxMem": otelCollectorMaxMem,
14 "otelSamplingPercentage": otelSamplingPercentage
15 }
16}
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | RequestBody参数 | 网关实例 ID |
| otelConfig | OtelModel | 是 | RequestBody参数 | OTel 链路追踪配置 |
返回头域
除公共头域,无其它特殊头域。
返回参数
无特殊返回参数。
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: instanceId must not be blank | 400 | 必填参数缺失或格式不合法,instanceId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON,无法解析,请检查 JSON 语法和字段类型 |
| RepeatedlyOpenOtel | The instance has been bound to OTel. | 400 | 实例已开启 OTel 链路追踪,无需重复开启 |
| InvalidOpenOtel | Invalid otelConfig for OpenOtel API. | 400 | otelConfig 不合法,请检查 OTel 配置参数 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源,请确认使用正确的账号凭证且资源属于当前账号 |
| InstanceNotExist | Instance not exist. | 404 | 实例不存在、不属于当前账号或已释放 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持,请使用 application/json |
请求示例
Plain Text
1POST /?action=OpenOtel HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "instanceId": "gw-a1b2c3d4",
7 "otelConfig": {
8 "enableOtel": true,
9 "otelCollectorReplicas": 1,
10 "otelSamplingPercentage": 100
11 }
12}
返回示例
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{}
评价此篇文章
