查询指标值
更新时间：2026-06-26
DescribeMetricData
指标数据查询，支持多指标同时查询、同比数据查询、GroupBy分组、排序与数量限制。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v1/apm/query?action=DescribeMetricData HTTP/1.1
2Host: apm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "metrics": [
7 {
8 "name": "apm_requests_count",
9 "compareTo": ["yesterday", "lastweek", "2024-11-11"],
10 "filters": [{"key": "gen_ai.kind", "op": "=", "value": "llm"}]
11 }
12 ],
13 "beginDatetime": "20241011T10:10:10Z",
14 "endDatetime": "20241011T10:25:10Z",
15 "filters": [
16 {
17 "key": "service.name",
18 "op": "=",
19 "value": "mall-gateway"
20 }
21 ],
22 "groupBy": ["service.name", "span.kind"],
23 "orderBy": "apm_requests_count",
24 "order": "desc",
25 "limit": 10,
26 "periodSeconds": 60,
27 "reserveEmptyDimensions": false
28}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为v1 |
| action | String | 是 | URL参数 | API接口名称，当前取值为DescribeMetricData |
| metrics | List<MetricQuery> | 是 | RequestBody参数 | 指标名列表 |
| metrics.name | String | 是 | RequestBody参数 | 指标名 |
| metrics.compareTo | List |
否 | RequestBody参数 | 同比数据，不填写表示不查询同比数据。可选值：5m（周期环比，支持m和h）、yesterday（昨日同比）、lastweek（上周同比）、YYYY-mm-dd（指定日期同比，UTC时间） |
| metrics.filters | List<Filter> | 否 | RequestBody参数 | 该指标的特殊过滤条件，会与全局过滤项列表进行合并 |
| beginDatetime | String | 是 | RequestBody参数 | 开始时间，UTC时间 |
| endDatetime | String | 是 | RequestBody参数 | 结束时间，UTC时间 |
| filters | List<Filter> | 否 | RequestBody参数 | 过滤项列表，所有指标共享 |
| groupBy | List |
否 | RequestBody参数 | GroupBy列表 |
| orderBy | String | 否 | RequestBody参数 | 排序字段 |
| order | String | 否 | RequestBody参数 | 排序方式，可选值：asc、desc |
| limit | Integer | 否 | RequestBody参数 | 返回数量限制，若未设置，后端服务将返回尽可能多的数据 |
| periodSeconds | Integer | 否 | RequestBody参数 | 聚合周期，单位：秒。每periodSeconds秒计算一个聚合点。若为0或未设置，表示从起止时间只计算一个聚合点。默认值：0 |
| reserveEmptyDimensions | Boolean | 否 | RequestBody参数 | 当dimensions为空时，是否保留对应的时间序列。默认值：false |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 状态码 |
| message | String | 错误信息 |
| timeseries | List<Timeseries> | 时序数据列表 |
请求示例
Plain Text
1POST /v1/apm/query?action=DescribeMetricData HTTP/1.1
2HOST apm.bj.baidubce.com
3Authorization bce-auth-v1/...
4
5{
6 "metrics": [
7 {
8 "name": "apm_requests_count",
9 "compareTo": ["yesterday", "lastweek", "2024-11-11"],
10 "filters": [{"key": "gen_ai.kind", "op": "=", "value": "llm"}]
11 }
12 ],
13 "beginDatetime": "20241011T10:10:10Z",
14 "endDatetime": "20241011T10:25:10Z",
15 "filters": [
16 {
17 "key": "service.name",
18 "op": "=",
19 "value": "mall-gateway"
20 }
21 ],
22 "groupBy": ["service.name", "span.kind"],
23 "orderBy": "apm_requests_count",
24 "order": "desc",
25 "limit": 10,
26 "periodSeconds": 60,
27 "reserveEmptyDimensions": false
28}响应示例
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 "timeseries": [
13 {
14 "metric": "apm_requests_count",
15 "dimensions": [
16 {
17 "key": "span.kind",
18 "value": "client"
19 },
20 {
21 "key": "service.name",
22 "value": "java-order-service"
23 }
24 ],
25 "data": [
26 [1656428160, 100],
27 [1656428220, 110]
28 ],
29 "compareTo": [
30 [
31 [1656341760, 90, 0.11],
32 [1656341820, 100, 0.1]
33 ],
34 [
35 [1655823360, 90, 0.11],
36 [1655823420, 100, 0.1]
37 ],
38 [
39 [1731320190, 90, 0.11],
40 [1731320250, 100, 0.1]
41 ]
42 ]
43 }
44 ]
45}评价此篇文章