查询指标

最近更新时间:2019-05-13 18:46:57

1. 接口描述

查看某个命名空间下已创建的指标。

域名:monitor.api.qcloud.com
接口名: DescribeMetric

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为DescribeMetric。

参数名 称 必选 类型 描述
namespace String 查询该命名空间下的指标,调用查询命名空间(DescribeNamespace)接口查询
metricName String 按指标名称筛选,不指定时返回本命名空间下所有指标信息

3. 输出参数

参数名称 类型 描述
code Int 错误码, 0: 成功, 其他值表示失败,详见错误码表
message String 错误信息
data Array 返回的数组

其中data返回的每个指标中的内容的含义

参数名称 类型 描述
namespace String 本指标所在的命名空间
metricName String 本指标名称
metricCname String 本指标中文名称
dimension String 指标维度名称
unit String 上报的数据显示的单位
statisticsType Array 统计类型
aggeration Array 聚合维度,当您有使用创建指标聚合接口时,可看到聚合信息

其中statisticsType的含义:

参数名称 类型 描述
period Int 统计周期,收集数据时间间隔,目前指定为300,单位为s,暂时不支持修改为其它值
statistics String 统计方法函数,对指定统计周期内的数据的集合做分析,分析的方法有max:取数据集合中的最大值,min:取数据集合中的最小值,sum:对数据集合中的数据求和、avg:数据集合中的数据平均值、last:数据集合中的最后一个数据的值

其中aggeration的array,key值为聚合的维度名称组合,value为统计类型

##4. 错误码表

错误代码 错误描述 英文描述
-503 请求参数有误 InvalidParameter
-505 参数缺失 InvalidParameter.MissingParameter
-507 超出限制 OperationDenied.ExceedLimit
-509 错误的维度组合 InvalidParameter.DimensionGroupError
-513 DB操作失败 InternalError.DBoperationFail

5. 示例

输入

 https://domain/v2/index.php?Action=DescribeMetric
 &<公共请求参数>
 &namespace=cvm

输出

{
    "code": 0,
    "message": "",
    "data": {
        "cvm": {
            "diskusage": {
                "namespace": "cvm",
                "metricName": "diskusage",
                "unit": "'%'",
                "metricCname": "'机器磁盘使用率'",
                "dimension": "diskname,ip",
                "statisticsType": [
                    {
                        "period": "300",
                        "statistics": "max"
                    },
                    {
                        "period": "300",
                        "statistics": "avg"
                    }
                ],
                "aggeration": {
                    "ip": [
                        {
                            "period": "300",
                            "statistics": "max"
                        }
                    ]
                }
            }
        }
    }
}