开发指南

API 文档

查询环境的监控曲线数据

最近更新时间:2021-08-05 08:08:42

我的收藏

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
MetricName String
  • 指标名:
  • StorageRead: 存储读请求次数
  • StorageWrite: 存储写请求次数
  • StorageCdnOriginFlux: CDN回源流量, 单位字节
  • CDNFlux: CDN回源流量, 单位字节
  • FunctionInvocation: 云函数调用次数
  • FunctionGBs: 云函数资源使用量, 单位Mb*Ms
  • FunctionFlux: 云函数流量, 单位千字节(KB)
  • FunctionError: 云函数调用错误次数
  • FunctionDuration: 云函数运行时间, 单位毫秒
  • DbRead: 数据库读请求数
  • DbWrite: 数据库写请求数
  • DbCostTime10ms: 数据库耗时在10ms50ms请求数
  • DbCostTime50ms: 数据库耗时在50ms100ms请求数
  • DbCostTime100ms: 数据库耗时在100ms以上请求数
  • TkeCpuRatio: 容器CPU占用率
  • TkeMemRatio: 容器内存占用率
  • TkeCpuUsed: 容器CPU使用量
  • TkeMemUsed: 容器内存使用量
  • TkeInvokeNum: 调用量
  • StartTime String 开始时间,如2018-08-24 10:50:00, 开始时间需要早于结束时间至少五分钟(原因是因为目前统计粒度最小是5分钟).
    EndTime String 结束时间,如2018-08-24 10:50:00, 结束时间需要晚于开始时间至少五分钟(原因是因为目前统计粒度最小是5分钟)..
    ResourceID String 资源ID, 目前仅对云函数、容器托管相关的指标有意义。云函数(FunctionInvocation, FunctionGBs, FunctionFlux, FunctionError, FunctionDuration)、容器托管(服务名称), 如果想查询某个云函数的指标则在ResourceId中传入函数名; 如果只想查询整个namespace的指标, 则留空或不传.如果想查询数据库某个集合相关信息,传入集合名称

    3. 输出参数

    参数名称 类型 描述
    StartTime String 开始时间, 会根据数据的统计周期进行取整.
    EndTime String 结束时间, 会根据数据的统计周期进行取整.
    MetricName String 指标名.
    Period Integer 统计周期(单位秒), 当时间区间为1天内, 统计周期为5分钟; 当时间区间选择为1天以上, 15天以下, 统计周期为1小时; 当时间区间选择为15天以上, 180天以下, 统计周期为1天.
    Values Array of Integer 有效的监控数据, 每个有效监控数据的上报时间可以从时间数组中的对应位置上获取到.
    Time Array of Integer 时间数据, 标识监控数据Values中的点是哪个时间段上报的.
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 示例

    输入示例

    https://tcb.tencentcloudapi.com/?Action=DescribeCurveData
    &MetricName=StorageRead
    &StartTime=2019-04-0209:00:00
    &EndTime=2019-04-0419:00:00
    &ResourceID=3
    &EnvId=lotestapi100004
    &<公共请求参数>

    输出示例

    {
    "Response": {
      "EndTime": "2019-04-04 19:00:00",
      "MetricName": "StorageRead",
      "Period": 3600,
      "RequestId": "6702e6bd-858d-4b19-89bb-5b183540186d",
      "StartTime": "2019-04-02 09:00:00",
      "Time": [
        1554894000,
        1554894300,
        1554894600,
        1554894900,
        1554895200
      ],
      "Values": [
        20,
        100,
        180,
        240,
        260
      ]
    }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    MissingParameter 缺少参数错误。
    MissingParameter.Param 缺少必要参数。
    ResourceNotFound 资源不存在。
    ResourceUnavailable 资源不可用。
    目录