获取指标数据通用接口

最近更新时间:2025-01-17 01:08:22

我的收藏

1. 接口描述

接口请求域名: apm.tencentcloudapi.com 。

获取指标数据通用接口。用户根据需要上送请求参数,返回对应的指标数据。
接口调用频率限制为:20次/秒,1200次/分钟。单请求的数据点数限制为1440个。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGeneralMetricData。
Version String 公共参数,本接口取值:2021-06-22。
Region String 公共参数,详见产品支持的 地域列表
Metrics.N Array of String 需要查询的指标名称,不可自定义输入,详情请见。
示例值:["request_count"、“duration”]
InstanceId String 业务系统 ID
示例值:apm-ylTJfTSbn
ViewName String 视图名称,不可自定义输入。详情请见。
示例值:service_metric
Filters.N Array of GeneralFilter 要过滤的维度信息,不同视图有对应的指标维度,详情请见。
GroupBy.N Array of String 聚合维度,不同视图有对应的指标维度,详情请见。
示例值:["service.name"、"span.kind"]
StartTime Integer 起始时间的时间戳,支持查询30天内的指标数据。(单位:秒)
示例值:1617123538
EndTime Integer 结束时间的时间戳,支持查询30天内的指标数据。(单位:秒)
示例值:1617123538
Period Integer 是否按固定时间跨度聚合,填入1及大于1的值按1处理,不填按0处理。
- 填入0,则计算开始时间到截止时间的指标数据。
- 填入1,则会按照开始时间到截止时间的时间跨度选择聚合粒度:
- 时间跨度 (0,12) 小时,则按一分钟粒度聚合。
- 时间跨度 [12,48] 小时,则按五分钟粒度聚合。
- 时间跨度 (48, +∞) 小时,则按一小时粒度聚合。
示例值:60
OrderBy OrderBy 对查询指标进行排序:
Key 填写云 API 指标名称,详情请见。
Value 填写排序方式:
- asc:对查询指标进行升序排序
- desc:对查询指标进行降序排序
示例值:{ "Key": "duration", "Value": "desc"
PageSize Integer 查询指标的限制条数,目前最多展示50条数据,PageSize取值为1-50,上送PageSize则根据PageSize的值展示限制条数。
示例值:5

3. 输出参数

参数名称 类型 描述
Records Array of Line 指标结果集
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询1分钟聚合粒度的 service_metric 指标数据示例

该示例查询业务系统为 apm-059oXBfTL,按照 service.name(应用名)、span.kind(客户端/服务端视角)为维度过滤,以 service.name(应用名)、span.kind(客户端/服务端视角)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 request_count(请求数量)、error_request_count(错误请求数量)、duration_avg(平均响应时间)、slow_request_count(慢请求数量)、duration_p50(耗时 p50)的指标数据。

输入示例

POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralMetricData
<公共请求参数>

{
    "Filters": [
        {
            "Key": "service.name",
            "Value": "ot-java-order-service"
        },
        {
            "Key": "span.kind",
            "Value": "client"
        }
    ],
    "ViewName": "service_metric",
    "InstanceId": "apm-059oXBfTL",
    "Period": 60,
    "Metrics": [
        "request_count",
        "error_request_count",
        "duration_avg",
        "slow_request_count",
        "duration_p50"
    ],
    "StartTime": 1734415200,
    "EndTime": 1734418800,
    "GroupBy": [
        "service.name",
        "span.kind"
    ]
}

输出示例

{
    "Response": {
        "Records": [
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "request_count",
                "MetricNameCN": "总请求数",
                "TimeSerial": [
                    1734415200,
                    1734415260,
                    1734415320,
                    1734415380,
                    1734415440,
                    1734415500,
                    1734415560,
                    1734415620,
                    1734415680,
                    1734415740,
                    1734415800,
                    1734415860,
                    1734415920,
                    1734415980,
                    1734416040,
                    1734416100,
                    1734416160,
                    1734416220,
                    1734416280,
                    1734416340,
                    1734416400,
                    1734416460,
                    1734416520,
                    1734416580,
                    1734416640,
                    1734416700,
                    1734416760,
                    1734416820,
                    1734416880,
                    1734416940,
                    1734417000,
                    1734417060,
                    1734417120,
                    1734417180,
                    1734417240,
                    1734417300,
                    1734417360,
                    1734417420,
                    1734417480,
                    1734417540,
                    1734417600,
                    1734417660,
                    1734417720,
                    1734417780,
                    1734417840,
                    1734417900,
                    1734417960,
                    1734418020,
                    1734418080,
                    1734418140,
                    1734418200,
                    1734418260,
                    1734418320,
                    1734418380,
                    1734418440,
                    1734418500,
                    1734418560,
                    1734418620,
                    1734418680,
                    1734418740
                ],
                "DataSerial": [
                    22,
                    32,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    32,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    26,
                    28,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    32,
                    12,
                    22,
                    22,
                    32,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    22,
                    32,
                    22,
                    12,
                    22,
                    22
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    },
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    }
                ],
                "MetricName": "error_request_count",
                "MetricNameCN": "异常数量",
                "TimeSerial": [
                    1734415200,
                    1734415260,
                    1734415320,
                    1734415380,
                    1734415440,
                    1734415500,
                    1734415560,
                    1734415620,
                    1734415680,
                    1734415740,
                    1734415800,
                    1734415860,
                    1734415920,
                    1734415980,
                    1734416040,
                    1734416100,
                    1734416160,
                    1734416220,
                    1734416280,
                    1734416340,
                    1734416400,
                    1734416460,
                    1734416520,
                    1734416580,
                    1734416640,
                    1734416700,
                    1734416760,
                    1734416820,
                    1734416880,
                    1734416940,
                    1734417000,
                    1734417060,
                    1734417120,
                    1734417180,
                    1734417240,
                    1734417300,
                    1734417360,
                    1734417420,
                    1734417480,
                    1734417540,
                    1734417600,
                    1734417660,
                    1734417720,
                    1734417780,
                    1734417840,
                    1734417900,
                    1734417960,
                    1734418020,
                    1734418080,
                    1734418140,
                    1734418200,
                    1734418260,
                    1734418320,
                    1734418380,
                    1734418440,
                    1734418500,
                    1734418560,
                    1734418620,
                    1734418680,
                    1734418740
                ],
                "DataSerial": [
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [
                    1734415200,
                    1734415260,
                    1734415320,
                    1734415380,
                    1734415440,
                    1734415500,
                    1734415560,
                    1734415620,
                    1734415680,
                    1734415740,
                    1734415800,
                    1734415860,
                    1734415920,
                    1734415980,
                    1734416040,
                    1734416100,
                    1734416160,
                    1734416220,
                    1734416280,
                    1734416340,
                    1734416400,
                    1734416460,
                    1734416520,
                    1734416580,
                    1734416640,
                    1734416700,
                    1734416760,
                    1734416820,
                    1734416880,
                    1734416940,
                    1734417000,
                    1734417060,
                    1734417120,
                    1734417180,
                    1734417240,
                    1734417300,
                    1734417360,
                    1734417420,
                    1734417480,
                    1734417540,
                    1734417600,
                    1734417660,
                    1734417720,
                    1734417780,
                    1734417840,
                    1734417900,
                    1734417960,
                    1734418020,
                    1734418080,
                    1734418140,
                    1734418200,
                    1734418260,
                    1734418320,
                    1734418380,
                    1734418440,
                    1734418500,
                    1734418560,
                    1734418620,
                    1734418680,
                    1734418740
                ],
                "DataSerial": [
                    191.5860133181818,
                    191.2110746363636,
                    191.23246599999996,
                    191.5040949090909,
                    191.934274,
                    192.05015977272723,
                    191.4917418636364,
                    191.7598401818182,
                    191.47329104545454,
                    191.35408840909093,
                    191.7695753181818,
                    192.1501132727273,
                    191.6614135,
                    191.72522395454544,
                    193.92501624242422,
                    209.9224584090909,
                    192.50587436363637,
                    193.14908313636363,
                    200.8337476363636,
                    192.21551695454545,
                    191.87317959090907,
                    191.85476931818184,
                    192.0314575909091,
                    192.14624168181817,
                    192.0624055,
                    192.35865707575758,
                    191.87331737878793,
                    191.806969,
                    192.35163881818187,
                    192.29478813636362,
                    192.3707790454545,
                    191.8557721363636,
                    191.59646177272725,
                    191.55687904545456,
                    191.59595163636365,
                    191.84944554545453,
                    191.78630649999997,
                    191.91973590909092,
                    191.90514081818182,
                    191.9165850909091,
                    191.98103199999997,
                    191.98323287878785,
                    193.0803381818182,
                    192.14093727272729,
                    192.24286899999998,
                    192.6753041818182,
                    192.2717468636364,
                    192.41461836363635,
                    192.3725805,
                    191.84485977272726,
                    191.85852840909092,
                    191.86218731818178,
                    191.6467590454545,
                    191.52699904545452,
                    191.57099809090911,
                    192.2197160909091,
                    191.91881845454546,
                    191.98860699999997,
                    224.0602859090909,
                    192.05223709090907
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "slow_request_count",
                "MetricNameCN": "慢调用",
                "TimeSerial": [
                    1734415200,
                    1734415260,
                    1734415320,
                    1734415380,
                    1734415440,
                    1734415500,
                    1734415560,
                    1734415620,
                    1734415680,
                    1734415740,
                    1734415800,
                    1734415860,
                    1734415920,
                    1734415980,
                    1734416040,
                    1734416100,
                    1734416160,
                    1734416220,
                    1734416280,
                    1734416340,
                    1734416400,
                    1734416460,
                    1734416520,
                    1734416580,
                    1734416640,
                    1734416700,
                    1734416760,
                    1734416820,
                    1734416880,
                    1734416940,
                    1734417000,
                    1734417060,
                    1734417120,
                    1734417180,
                    1734417240,
                    1734417300,
                    1734417360,
                    1734417420,
                    1734417480,
                    1734417540,
                    1734417600,
                    1734417660,
                    1734417720,
                    1734417780,
                    1734417840,
                    1734417900,
                    1734417960,
                    1734418020,
                    1734418080,
                    1734418140,
                    1734418200,
                    1734418260,
                    1734418320,
                    1734418380,
                    1734418440,
                    1734418500,
                    1734418560,
                    1734418620,
                    1734418680,
                    1734418740
                ],
                "DataSerial": [
                    2,
                    3,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    3,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    3,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    3,
                    1,
                    2,
                    2,
                    3,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    2,
                    3,
                    2,
                    1,
                    2,
                    2
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "duration_p50",
                "MetricNameCN": "P50 响应时间",
                "TimeSerial": [
                    1734415200,
                    1734415260,
                    1734415320,
                    1734415380,
                    1734415440,
                    1734415500,
                    1734415560,
                    1734415620,
                    1734415680,
                    1734415740,
                    1734415800,
                    1734415860,
                    1734415920,
                    1734415980,
                    1734416040,
                    1734416100,
                    1734416160,
                    1734416220,
                    1734416280,
                    1734416340,
                    1734416400,
                    1734416460,
                    1734416520,
                    1734416580,
                    1734416640,
                    1734416700,
                    1734416760,
                    1734416820,
                    1734416880,
                    1734416940,
                    1734417000,
                    1734417060,
                    1734417120,
                    1734417180,
                    1734417240,
                    1734417300,
                    1734417360,
                    1734417420,
                    1734417480,
                    1734417540,
                    1734417600,
                    1734417660,
                    1734417720,
                    1734417780,
                    1734417840,
                    1734417900,
                    1734417960,
                    1734418020,
                    1734418080,
                    1734418140,
                    1734418200,
                    1734418260,
                    1734418320,
                    1734418380,
                    1734418440,
                    1734418500,
                    1734418560,
                    1734418620,
                    1734418680,
                    1734418740
                ],
                "DataSerial": [
                    10,
                    10,
                    9.375,
                    14,
                    14,
                    14,
                    10,
                    9.375,
                    9.285714285714285,
                    9.166666666666668,
                    10,
                    14,
                    14,
                    14,
                    15.714285714285714,
                    14.444444444444445,
                    14,
                    14,
                    14.444444444444445,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    13.333333333333332,
                    16.153846153846153,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    15.333333333333332,
                    16.666666666666664,
                    14,
                    14,
                    15.333333333333332,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    14,
                    15.333333333333332,
                    14,
                    10,
                    14.444444444444445,
                    14
                ]
            }
        ],
        "RequestId": "test-test-test"
    }
}

示例2 查询起始到终止时间内统计 service_metric 指标数据示例

该示例查询业务系统为 apm-059oXBfTL,按照 service.name(应用名)、span.kind(客户端/服务端视角)为维度过滤,以 service.name(应用名)、span.kind(客户端/服务端视角)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 request_count(请求数量)、error_request_count(错误请求数量)、duration_avg(平均响应时间)、slow_request_count(慢请求数量)、duration_p50(耗时 p50)的指标数据。

输入示例

POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralMetricData
<公共请求参数>

{
    "Filters": [
        {
            "Key": "service.name",
            "Value": "ot-java-order-service"
        },
        {
            "Key": "span.kind",
            "Value": "client"
        }
    ],
    "ViewName": "service_metric",
    "InstanceId": "apm-059oXBfTL",
    "Metrics": [
        "request_count",
        "error_request_count",
        "duration_avg",
        "slow_request_count",
        "duration_p50"
    ],
    "StartTime": 1734415200,
    "EndTime": 1734418800,
    "GroupBy": [
        "service.name",
        "span.kind"
    ]
}

输出示例

{
    "Response": {
        "Records": [
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "request_count",
                "MetricNameCN": "总请求数",
                "TimeSerial": [],
                "DataSerial": [
                    1360
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "error_request_count",
                "MetricNameCN": "异常数量",
                "TimeSerial": [],
                "DataSerial": [
                    0
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    192.96957006641412
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "slow_request_count",
                "MetricNameCN": "慢调用",
                "TimeSerial": [],
                "DataSerial": [
                    124
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    },
                    {
                        "Key": "span.kind",
                        "Value": "client"
                    }
                ],
                "MetricName": "duration_p50",
                "MetricNameCN": "P50 响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    13.443708609271523
                ]
            }
        ],
        "RequestId": "test-test-test"
    }
}

示例3 查询1分钟聚合粒度的 sql_metric 指标数据示例

该示例查询业务系统为 apm-059oXBfTL,按照 service.name(应用名)为维度过滤,以 service.name(应用名)进行聚合,查找开始时间-终止时间内以一分钟为聚合粒度的 error_request_count(错误请求数量)、duration_avg(平均响应时间)的指标数据。

输入示例

POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralMetricData
<公共请求参数>

{
    "Filters": [
        {
            "Key": "service.name",
            "Value": "ot-java-order-service"
        }
    ],
    "ViewName": "sql_metric",
    "InstanceId": "apm-059oXBfTL",
    "Period": 60,
    "Metrics": [
        "error_request_count",
        "duration_avg"
    ],
    "StartTime": 1734415200,
    "EndTime": 1734418800,
    "GroupBy": [
        "service.name"
    ]
}

输出示例

{
    "Response": {
        "Records": [
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    }
                ],
                "MetricName": "error_request_count",
                "MetricNameCN": "错误数",
                "TimeSerial": [
                    1734415200,
                    1734415260,
                    1734415320,
                    1734415380,
                    1734415440,
                    1734415500,
                    1734415560,
                    1734415620,
                    1734415680,
                    1734415740,
                    1734415800,
                    1734415860,
                    1734415920,
                    1734415980,
                    1734416040,
                    1734416100,
                    1734416160,
                    1734416220,
                    1734416280,
                    1734416340,
                    1734416400,
                    1734416460,
                    1734416520,
                    1734416580,
                    1734416640,
                    1734416700,
                    1734416760,
                    1734416820,
                    1734416880,
                    1734416940,
                    1734417000,
                    1734417060,
                    1734417120,
                    1734417180,
                    1734417240,
                    1734417300,
                    1734417360,
                    1734417420,
                    1734417480,
                    1734417540,
                    1734417600,
                    1734417660,
                    1734417720,
                    1734417780,
                    1734417840,
                    1734417900,
                    1734417960,
                    1734418020,
                    1734418080,
                    1734418140,
                    1734418200,
                    1734418260,
                    1734418320,
                    1734418380,
                    1734418440,
                    1734418500,
                    1734418560,
                    1734418620,
                    1734418680,
                    1734418740
                ],
                "DataSerial": [
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [
                    1734415200,
                    1734415260,
                    1734415320,
                    1734415380,
                    1734415440,
                    1734415500,
                    1734415560,
                    1734415620,
                    1734415680,
                    1734415740,
                    1734415800,
                    1734415860,
                    1734415920,
                    1734415980,
                    1734416040,
                    1734416100,
                    1734416160,
                    1734416220,
                    1734416280,
                    1734416340,
                    1734416400,
                    1734416460,
                    1734416520,
                    1734416580,
                    1734416640,
                    1734416700,
                    1734416760,
                    1734416820,
                    1734416880,
                    1734416940,
                    1734417000,
                    1734417060,
                    1734417120,
                    1734417180,
                    1734417240,
                    1734417300,
                    1734417360,
                    1734417420,
                    1734417480,
                    1734417540,
                    1734417600,
                    1734417660,
                    1734417720,
                    1734417780,
                    1734417840,
                    1734417900,
                    1734417960,
                    1734418020,
                    1734418080,
                    1734418140,
                    1734418200,
                    1734418260,
                    1734418320,
                    1734418380,
                    1734418440,
                    1734418500,
                    1734418560,
                    1734418620,
                    1734418680,
                    1734418740
                ],
                "DataSerial": [
                    504.4455225,
                    504.49955074999997,
                    504.50165175000006,
                    504.55699425,
                    504.5483053749999,
                    504.547519,
                    504.73789837500004,
                    504.46199262500005,
                    504.1922,
                    504.22497787500004,
                    504.18011225000004,
                    504.04929475,
                    504.14939112499997,
                    504.45689225,
                    504.4441259166667,
                    504.4853475,
                    504.55031125,
                    504.458504875,
                    504.49732837499994,
                    504.50629599999996,
                    504.439337,
                    504.272122,
                    504.267848625,
                    504.28821525,
                    504.268522875,
                    504.28563437500003,
                    504.25491391666674,
                    504.20538062500003,
                    504.54045425000004,
                    504.67349375000003,
                    504.71599025,
                    504.54132337499993,
                    504.69503825,
                    504.74425037500004,
                    504.637164375,
                    504.62155600000006,
                    504.628113,
                    505.07725949999997,
                    504.65562800000004,
                    504.443061375,
                    504.420146125,
                    504.41736325000005,
                    507.28285875,
                    504.59916025,
                    504.50750687499993,
                    504.67656166666666,
                    504.687698625,
                    504.7468005,
                    504.728723,
                    504.71881125,
                    504.6750935,
                    504.45997087499995,
                    504.48766912499997,
                    504.5063645,
                    504.670277625,
                    504.88526525,
                    505.09475625,
                    505.13066475,
                    505.103745375,
                    505.101275
                ]
            }
        ],
        "RequestId": "test-test-test"
    }
}

示例4 查询起始到终止时间内统计 sql_metric 的 duration_avg(耗时时间)指标数据示例

该示例查询业务系统为apm-059oXBfTL,按照 db.instance(数据库名称)为维度过滤,以 service.name(应用名)、db.statement(执行语句)为维度进行聚合,查找开始时间-终止时间内 top5 的 duration_avg(耗时(ms))的指标数据。

输入示例

POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralMetricData
<公共请求参数>

{
    "Filters": [
        {
            "Key": "db.instance",
            "Value": "mock_project_db"
        }
    ],
    "ViewName": "sql_metric",
    "InstanceId": "apm-059oXBfTL",
    "Metrics": [
        "duration_avg"
    ],
    "StartTime": 1734415200,
    "EndTime": 1734418800,
    "GroupBy": [
        "service.name",
        "db.statement"
    ],
    "OrderBy": {
        "Key": "sql_duration_avg",
        "Value": "desc"
    },
    "PageSize": 5
}

输出示例

{
    "Response": {
        "Records": [
            {
                "Tags": [
                    {
                        "Key": "db.statement",
                        "Value": "select sleep(?)"
                    },
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    2005.583661869444
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-stock-service"
                    },
                    {
                        "Key": "db.statement",
                        "Value": "select dept, count(dept) as total from mock_project_userinfo"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    5.746467460185185
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "db.statement",
                        "Value": "select dept, count(dept) as total from mock_project_userinfo"
                    },
                    {
                        "Key": "service.name",
                        "Value": "ot-java-user-service"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    5.719407256481479
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "db.statement",
                        "Value": "select * from mock_project_userinfo"
                    },
                    {
                        "Key": "service.name",
                        "Value": "ot-java-order-service"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    5.677464627777778
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "db.statement",
                        "Value": "select * from mock_project_userinfo"
                    },
                    {
                        "Key": "service.name",
                        "Value": "ot-java-delivery-service"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    5.636013505555556
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "db.statement",
                        "Value": "select * om un_exist_table limit ?"
                    },
                    {
                        "Key": "service.name",
                        "Value": "ot-java-delivery-service"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    5.514262441666669
                ]
            },
            {
                "Tags": [
                    {
                        "Key": "db.statement",
                        "Value": "select dept, count(dept) as total from mock_project_userinfo"
                    },
                    {
                        "Key": "service.name",
                        "Value": "ot-java-market-service"
                    }
                ],
                "MetricName": "duration_avg",
                "MetricNameCN": "平均响应时间",
                "TimeSerial": [],
                "DataSerial": [
                    5.44814345277778
                ]
            }
        ],
        "RequestId": "test-test-test"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.AppIdNotMatchInstanceInfo AppID 和业务系统信息不匹配。
FailedOperation.InstanceIdIsEmpty 业务系统 ID 为空。
FailedOperation.InstanceNotFound APM 业务系统不存在。
FailedOperation.InvalidInstanceID 非法业务系统 ID。
FailedOperation.MetricFiltersLackParams 查询指标类数据查询条件缺少过滤参数。
FailedOperation.QueryTimeIntervalIsNotSupported 查询时间区间不支持。
FailedOperation.ViewNameNotExistOrIllegal 视图名不存在或非法。
InvalidParameter.FiltersFieldsNotExistOrIllegal Filters 中的字段不存在或非法。
InvalidParameter.GroupByFieldsNotExistOrIllegal GroupBy 中的字段不存在或非法。
InvalidParameter.MetricFiltersLackParams Filters 中必须存在 service.name 字段,否则会报错。
InvalidParameter.MetricsFieldNotExistOrIllegal Metrics 中的字段不存在或非法。
InvalidParameter.MetricsFieldsNotAllowEmpty Metrics 中不允许为空。
InvalidParameter.PeriodIsIllegal Period不为空,0或60。
InvalidParameter.QueryTimeIntervalIsNotSupported 查询时间不支持,最多只能查询最近30天的数据。
InvalidParameter.ViewNameNotExistOrIllegal 视图名称不存在或非法。