操作指南

云产品指标

API 文档

获取基础指标属性

最近更新时间:2021-04-08 08:06:11

我的收藏

1. 接口描述

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

获取基础指标属性

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:monitor.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBaseMetrics。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Namespace String 业务命名空间,各个云产品的业务命名空间不同。如需获取业务命名空间,请前往各产品监控指标文档,例如云服务器的命名空间,可参见 云服务器监控指标
MetricName String 指标名,各个云产品的指标名不同。如需获取指标名,请前往各产品监控指标文档,例如云服务器的指标名,可参见 云服务器监控指标

3. 输出参数

参数名称 类型 描述
MetricSet Array of MetricSet 查询得到的指标描述列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取监控指标列表

查询基础监控指标的种类。查询到对应的名字空间下面的监控指标类型。

输入示例

https://monitor.tencentcloudapi.com/?Action=DescribeBaseMetrics
&Namespace=QCE/CVM
&MetricName=AccOuttraffic
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "15e8eb48-e445-48b5-97ca-985908e207bb",
    "MetricSet": [
      {
        "Namespace": "QCE/CVM",
        "MetricName": "AccOuttraffic",
        "Unit": "MB",
        "UnitCname": "",
        "Period": [
          10,
          60,
          300,
          3600,
          86400
        ],
        "Periods": [
          {
            "Period": "10",
            "StatType": [
              "sum"
            ]
          },
          {
            "Period": "60",
            "StatType": [
              "sum"
            ]
          },
          {
            "Period": "300",
            "StatType": [
              "sum"
            ]
          },
          {
            "Period": "3600",
            "StatType": [
              "sum"
            ]
          },
          {
            "Period": "86400",
            "StatType": [
              "sum"
            ]
          }
        ],
        "Dimensions": [
          {
            "Dimensions": [
              "InstanceId"
            ]
          }
        ],
        "Meaning": {
          "En": "",
          "Zh": "外网网卡的平均每秒出流量"
        }
      }
    ]
  }
}

示例2 获取监控指标列表(QCE/CDB)

查询基础监控指标的种类。查询到对应的名字空间下面的监控指标类型。

输入示例

https://monitor.tencentcloudapi.com/?Action=DescribeBaseMetrics
&Namespace=QCE/CDB
&MetricName=BytesReceived
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "2102703c-a1bb-4f71-9eb8-58cdfb544590",
    "MetricSet": [
      {
        "Namespace": "QCE/CDB",
        "MetricName": "BytesReceived",
        "Unit": "Bps",
        "UnitCname": "",
        "Period": [
          60,
          300,
          3600,
          86400
        ],
        "Periods": [
          {
            "Period": "60",
            "StatType": [
              "max"
            ]
          },
          {
            "Period": "300",
            "StatType": [
              "max"
            ]
          },
          {
            "Period": "3600",
            "StatType": [
              "max"
            ]
          },
          {
            "Period": "86400",
            "StatType": [
              "max"
            ]
          }
        ],
        "Dimensions": [
          {
            "Dimensions": [
              "InstanceId",
              "InstanceType"
            ]
          }
        ],
        "Meaning": {
          "En": "",
          "Zh": "接受数据量"
        }
      }
    ]
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码

目录