操作指南

API 文档

云产品监控指标

根据维度条件查询监控数据

最近更新时间:2022-04-21 06:15:18

我的收藏

1. 接口描述

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

根据维度条件查询监控数据

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStatisticData。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 所属模块,固定值,为monitor
Namespace String 命名空间,目前只支持QCE/TKE
MetricNames.N Array of String 指标名列表
Conditions.N Array of MidQueryCondition 维度条件,操作符支持=、in
Period Integer 统计粒度。默认取值为300,单位为s;可选的值为60、300、3600、86400
受存储时长限制,统计粒度与统计的时间范围有关:
60s:EndTime-StartTime<12小时,且StartTime距当前时间不能超过15天;
300s:EndTime-StartTime<3天,且StartTime距当前时间不能超过31天;
3600s:EndTime-StartTime<30天,且StartTime距当前时间不能超过93天;
86400s:EndTime-StartTime<186天,且StartTime距当前时间不能超过186天。
StartTime String 起始时间,默认为当前时间,如2020-12-08T19:51:23+08:00
EndTime String 结束时间,默认为当前时间,如2020-12-08T19:51:23+08:00
GroupBys.N Array of String 按指定维度groupBy

3. 输出参数

参数名称 类型 描述
Period Integer 统计周期
StartTime String 开始时间
EndTime String 结束时间
Data Array of MetricData 监控数据
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据维度条件查询监控数据

输入示例

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

{
    "Module": "monitor",
    "Namespace": "QCE/TKE",
    "MetricNames": [
        "K8sPodCpuCoreUsed"
    ],
    "Period": 300,
    "Conditions": [
        {
            "Key": "tke_cluster_instance_id",
            "Operator": "=",
            "Value": [
                "cls-mw2w40s7"
            ]
        }
    ],
    "StartTime": "2020-11-24T15:15:50+08:00",
    "EndTime": "2020-11-24T15:25:50+08:00"
}

输出示例

{
  "Response": {
    "Data": [
      {
        "MetricName": "K8sPodCpuCoreUsed",
        "Points": [
          {
            "Dimensions": [
              {
                "Name": "tke_cluster_instance_id",
                "Value": "cls-mw2w40s7"
              },
              {
                "Name": "node",
                "Value": "cls-gn7vut9a-virtual-kubelet-subnet-node-2"
              },
              {
                "Name": "pod_name",
                "Value": "proxy-edge-j7j95"
              },
              {
                "Name": "workload_name",
                "Value": "init-test-nfs02"
              },
              {
                "Name": "namespace",
                "Value": "default-test"
              },
              {
                "Name": "node_role",
                "Value": "node"
              },
              {
                "Name": "un_instance_id",
                "Value": "cls-gn7vut9a-virtual-kubelet-subnet-nmpi5ecw-1"
              },
              {
                "Name": "workload_kind",
                "Value": "Deployment"
              }
            ],
            "Values": [
              {
                "Timestamp": 1606202100,
                "Value": 41.066
              },
              {
                "Timestamp": 1606202400,
                "Value": 38.666
              },
              {
                "Timestamp": 1606202700,
                "Value": 37.866
              }
            ]
          },
          {
            "Dimensions": [
              {
                "Name": "namespace",
                "Value": "default-test"
              },
              {
                "Name": "node",
                "Value": "cls-gn7vut9a-virtual-kubelet-subnet-node-3"
              },
              {
                "Name": "node_role",
                "Value": "node"
              },
              {
                "Name": "pod_name",
                "Value": "network-tools-b94d6dd89-flf7n"
              },
              {
                "Name": "un_instance_id",
                "Value": "cls-gn7vut9a-virtual-kubelet-subnet-nmpi5ecw-1"
              },
              {
                "Name": "workload_kind",
                "Value": "Deployment"
              },
              {
                "Name": "workload_name",
                "Value": "init-test-nfs00"
              },
              {
                "Name": "tke_cluster_instance_id",
                "Value": "cls-mw2w40s7"
              }
            ],
            "Values": [
              {
                "Timestamp": 1606202100,
                "Value": 42.666
              },
              {
                "Timestamp": 1606202400,
                "Value": 33.6
              },
              {
                "Timestamp": 1606202700,
                "Value": 40.266
              }
            ]
          }
        ]
      }
    ],
    "EndTime": "2020-11-24 15:25:00",
    "Period": 300,
    "RequestId": "0d25d659-71ee-4c93-b8e1-f3992c61ff46",
    "StartTime": "2020-11-24 15:15:00"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 请求未授权。请参考 CAM 文档对鉴权的说明。
FailedOperation 操作失败。
FailedOperation.DataColumnNotFound 数据表字段不存在。
FailedOperation.DataQueryFailed 数据查询失败。
FailedOperation.DataTableNotFound 数据表不存在。
FailedOperation.DbQueryFailed 数据库查询失败。
FailedOperation.DbRecordCreateFailed 创建数据库记录失败。
FailedOperation.DbRecordDeleteFailed 数据库记录删除失败。
FailedOperation.DbRecordUpdateFailed 数据库记录更新失败。
FailedOperation.DbTransactionBeginFailed 数据库事务开始失败。
FailedOperation.DbTransactionCommitFailed 数据库事务提交失败。
FailedOperation.DimQueryRequestFailed 请求维度查询服务失败。
FailedOperation.DivisionByZero 被除数为0。
InternalError 内部错误。
InternalError.CallbackFail 回调出错。
InternalError.DependsApi 依赖的其他api出错。
InternalError.DependsDb 依赖的db出错。
InternalError.DependsMq 依赖的mq出错。
InternalError.ExeTimeout 执行超时。
InternalError.System 系统错误。
InternalError.TaskResultFormat 任务结果解析错误。
InvalidParameter 参数错误。
InvalidParameter.DupTask 重复提交任务。
InvalidParameter.InvalidParameter 参数错误。
InvalidParameter.InvalidParameterParam 参数错误。
InvalidParameter.MissAKSK 缺少平台配置。
InvalidParameter.ParamError 参数错误。
InvalidParameter.SecretIdOrSecretKeyError 平台配置错误。
InvalidParameter.UnsupportedProduct 这个产品还不支持扫描。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DashboardNameExists dashboard 名重复。
InvalidParameterValue.VersionMismatch 版本不匹配。
LimitExceeded 超过配额限制。
LimitExceeded.MetricQuotaExceeded 指标数量达到配额限制,禁止含有未注册指标的请求。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceNotFound.NotExistTask 任务不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
目录