1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
根据指定指标名称,查询某环境在指定时间范围内的监控数据,返回按统计粒度聚合后的时序数据。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCurveData。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境ID 示例值:lotestapi100004 |
| MetricName | 是 | String | 文档型数据库相关指标SQL型数据库相关指标云函数相关指标云托管相关指标静态网站托管相关指标身份认证相关指标API调用相关指标HTTP网关相关指标大模型相关指标知识库相关指标用户登录相关指标示例值:DbSizepkg |
| StartTime | 是 | String | 开始时间,如2018-08-24 10:50:00, 开始时间需要早于结束时间至少五分钟(原因是因为目前统计粒度最小是5分钟) 示例值:2019-04-02 09:00:00 |
| EndTime | 是 | String | 结束时间,如2018-08-24 10:50:00, 结束时间需要晚于开始时间至少五分钟(原因是因为目前统计粒度最小是5分钟) 示例值:2019-04-04 19:00:00 |
| ResourceID | 否 | String | 资源ID, 目前仅对文档型数据库、云函数、云托管相关的指标有意义。 如果想查询某个具体云函数/具体数据库集合的指标,则需传入对应的云函数名称/集合名称;如果只想查询整个namespace的指标, 则留空或不传。 云托管相关指标的查询,必须传入云托管服务名称。 示例值:ibot-agent1 |
| WxAppId | 否 | String | 微信AppId,微信必传 示例值:wxappid |
| SubresourceID | 否 | String | 子资源信息。 查询云托管相关指标的具体版本的监控数据,需传入。 示例值:deepseek |
| ThirdResource | 否 | String | 网关路由 示例值:resource |
| Period | 否 | Integer | 统计周期(单位秒),非必传,传入时仅支持传入300,3600,86400。不传采用默认以下默认规则:当时间区间为1天内, 统计周期为300;当时间区间选择为1天以上, 15天以下, 统计周期为3600; 当时间区间选择为15天以上, 180天以下, 统计周期为86400。 如果传入period,需遵循以下规则。EndTime-StartTime的时间范围不超过1 天,Period可以取300或3600;EndTime-StartTime的时间范围满足超过1天且不超过3 天,Period可以取300或3600或86400;EndTime-StartTime的时间范围超过3天时,Period可以取3600或86400。 示例值:300 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| StartTime | String | 开始时间, 会根据数据的统计周期进行取整 示例值:2019-04-02 09:00:00 |
| EndTime | String | 结束时间, 会根据数据的统计周期进行取整 示例值:2019-04-04 19:00:00 |
| MetricName | String | 指标名 示例值:DbSizepkg |
| Period | Integer | 统计周期(单位秒), 当时间区间为1天内, 统计周期为5分钟; 当时间区间选择为1天以上, 15天以下, 统计周期为1小时; 当时间区间选择为15天以上, 180天以下, 统计周期为1天 示例值:3600 |
| Values | Array of Integer | 有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到 示例值:[20,100,180,240,260] |
| Time | Array of Integer | 各数据点的时间戳数组(Unix 时间戳,秒级),与 Values 一一对应 示例值:[1554894000,1554894300,1554894600,1554894900,1554895200] |
| NewValues | Array of Float | 有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到 示例值:[20.0,100.0,180.0,240.0,260.0] |
| Statistics | String | 聚合方式, "last" 表示取时间段内最后一个值,“max”表示取时间段内最大值,“avg”表示取时间段内的平均值 示例值:max |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据用户传入的指标以及时间粒度,拉取一段时间内的监控数据
静态托管相关指标,无须传入ResourceID。传入与时间范围相匹配的时间粒度Period,返回指定时间粒度和时间范围的监控数据。
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCurveData
<公共请求参数>
{
"EnvId": "envid-xxxxx",
"MetricName": "StaticFsSizePkg",
"StartTime": "2026-02-05 00:00:00",
"EndTime": "2026-02-06 23:59:59",
"Period": 3600
}
输出示例
{
"Response": {
"EndTime": "2026-02-06 23:00:00",
"MetricName": "StaticFsSizePkg",
"NewValues": [
1
],
"Period": 3600,
"StartTime": "2026-02-05 00:00:00",
"Statistics": "last",
"Time": [
1770220800
],
"Values": [
1
],
"RequestId": "74126bc4-9fa1-4891-891b-b9ba41ea664a"
}
}
示例2 根据用户传入的指标,拉取一段时间内的监控数据
云托管相关指标,需要传入ResourceID。不传入period,返回默认时间粒度的指标。
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCurveData
<公共请求参数>
{
"EnvId": "envid-xxxxxxx",
"MetricName": "TkeInvokeNumService",
"StartTime": "2026-03-16 00:00:00",
"EndTime": "2026-03-16 23:59:59",
"ResourceID": "ibot-agent123"
}
输出示例
{
"Response": {
"EndTime": "2026-03-16 23:55:00",
"MetricName": "TkeInvokeNumService",
"NewValues": [
0
],
"Period": 300,
"StartTime": "2026-03-16 00:00:00",
"Statistics": "sum",
"Time": [
1773590400
],
"Values": [
0
],
"RequestId": "cd2cec9d-c0e9-4bab-b889-0ccc230cdc83"
}
}
示例3 根据用户传入的指标以及资源id,拉取一段时间内的监控数据
查询云托管某个版本的监控数据,需要传入ResourceID以及SubresourceID。不传入period,返回默认时间粒度的指标。
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCurveData
<公共请求参数>
{
"EnvId": "envid-xxxxx",
"MetricName": "TkeHttpErrorService",
"StartTime": "2026-03-13 00:00:00",
"EndTime": "2026-03-16 23:59:59",
"ResourceID": "ibot-agent123",
"SubresourceID": "ibot-agent123-001"
}
输出示例
{
"Response": {
"EndTime": "2026-03-16 23:00:00",
"MetricName": "TkeHttpErrorService",
"NewValues": [
0
],
"Period": 3600,
"StartTime": "2026-03-13 00:00:00",
"Statistics": "sum",
"Time": [
1773331200
],
"Values": [
0
],
"RequestId": "e9271644-4eb0-4b17-981a-330f2ca534b1"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.Param | 缺少必要参数。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |