查询应用配置
更新时间:2026-06-26
DescribeServiceConfig
查询应用配置,包括采样配置、日志关联配置、调用配置、拓扑图配置和多模态数据转储配置。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v1/apm?action=DescribeServiceConfig HTTP/1.1
2Host: apm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "serviceName": "mall-gateway"
7}
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为v1 |
| serviceName | String | 是 | RequestBody参数 | 应用名 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 状态码 |
| message | String | 错误信息 |
| language | String | 语言 |
| includeLLM | Boolean | 是否是LLM应用 |
| serviceDisplayName | String | 服务显示名,当该字段被设置时,Console应用名称显示该字段 |
| sampleConfig | SampleConfig | 采样配置 |
| loggingConfig | LoggingConfig | 日志关联配置 |
| requestConfig | ServiceRequestConfig | 调用配置 |
| topoConfig | ServiceTopoConfig | 拓扑图配置 |
| mllmResourceDumpConfig | MllmResourceDumpConfig | 多模态数据转储配置 |
请求示例
Plain Text
1POST /v1/apm?action=DescribeServiceConfig HTTP/1.1
2HOST apm.bj.baidubce.com
3Authorization bce-auth-v1/...
4
5{
6 "serviceName": "mall-gateway"
7}
响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: request-id-example
3Date: Wed, 08 Jan 2025 03:25:48 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "success": true,
10 "code": "OK",
11 "message": "",
12 "language": "java",
13 "includeLLM": false,
14 "serviceDisplayName": "",
15 "sampleConfig": {
16 "enabled": true,
17 "processors": [
18 {
19 "name": "component采样器",
20 "enabled": true,
21 "filters": [
22 {
23 "key": "attributes.apm_component",
24 "op": "=",
25 "value": "http"
26 }
27 ],
28 "sampleRate": 0.2
29 }
30 ]
31 },
32 "loggingConfig": {
33 "enabled": true,
34 "region": "bj",
35 "project": "default",
36 "logStoreName": "bcm_csm_log",
37 "traceIdIndex": "FIELD",
38 "traceIdKey": "trace_id",
39 "spanIdIndex": "FIELD",
40 "spanIdKey": "span_id"
41 },
42 "requestConfig": {
43 "global": true,
44 "serverSlowRequestThresholdSeconds": 0.5,
45 "dbSlowRequestThresholdSeconds": 0.5,
46 "okHttpStatus": [400, 403, 404]
47 },
48 "topoConfig": {
49 "global": true,
50 "requestSecondsThreshold": 0.5,
51 "errorRateThreshold": 0.2
52 },
53 "mllmResourceDumpConfig": {
54 "retentionDays": 20,
55 "bucket": "bostest"
56 }
57}
评价此篇文章
