云监控服务 CES云监控服务 CES

更新时间:2021/10/08 GMT+08:00
分享

批量查询监控数据

功能介绍

批量查询指定时间范围内指定指标的指定粒度的监控数据,目前最多支持500指标的批量查询。

URI

POST /V1.0/{project_id}/batch-query-metric-data

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    项目ID。

    获取方式请参见获取项目ID

请求消息

  1. 单次POST请求消息体大小不能超过512KB,否则请求会被服务端拒绝。
  2. 对于不同的period取值和查询的指标数量,默认的最大查询区间(to - from)不同,规则为“指标数量 * (to - from) / 监控周期 3000”。
    • 当period值为“1”时,监控周期为60*1000ms=60000ms。
    • 当period值为"300" 时,监控周期为300*1000ms=300000ms。
    • 当period值为"1200" 时,监控周期为1200*1000ms=1200000ms。
    • 当period值为"3600" 时,监控周期为3600*1000ms=3600000ms。
    • 当period值为"14400" 时,监控周期为14400*1000ms=14400000ms。
    • 当period值为"86400" 时,监控周期为86400*1000ms=86400000ms。

    例如批量查询300个指标,监控周期为60000ms,可算出(to - from)最大值为"600000",若设定的请求参数使(to - from)超出最大值,from值会自动调整为"to-600000"。

  • 请求参数
    表2 请求参数

    名称

    是否必选

    参数类型

    说明

    metrics

    Arrays of objects

    指标数据。数组长度最大500。

    详细参数请参见表3

    from

    long

    查询数据起始时间,UNIX时间戳,单位毫秒。建议from的值相对于当前时间向前偏移至少1个周期。由于聚合运算的过程是将一个聚合周期范围内的数据点聚合到周期起始边界上,如果将from和to的范围设置在聚合周期内,会因为聚合未完成而造成查询数据为空,所以建议from参数相对于当前时间向前偏移至少1个周期。以5分钟聚合周期为例:假设当前时间点为10:35,10:30~10:35之间的原始数据会被聚合到10:30这个点上,所以查询5分钟数据点时from参数应为10:30或之前。

    说明:

    云监控会根据所选择的聚合粒度向前取整from参数。

    to

    long

    查询数据截止时间UNIX时间戳,单位毫秒。from必须小于to。

    period

    String

    监控数据粒度。

    枚举值,取值范围:

    • "1",原始数据
    • "300",5分钟粒度
    • "1200",20分钟粒度
    • "3600",1小时粒度
    • "14400",4小时粒度
    • "86400",1天粒度

    filter

    String

    数据聚合方式,支持的聚合方式如下:

    • average:聚合周期内指标数据的平均值。
    • max:聚合周期内指标数据的最大值。
    • min:聚合周期内指标数据的最小值。
    • sum:聚合周期内指标数据的求和值。
    • variance:聚合周期内指标数据的方差。

    filter参数的值不会影响原始数据(period为1)的查询结果。

    表3 metrics字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    namespace

    String

    指标命名空间,格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_,service.item总长度最短为3,最大为32。

    dimensions

    Arrays of objects

    指标维度列表。

    单个维度为json对象,结构说明如下:

    {

    "name": "instance_id",

    "value": "33328f02-3814-422e-b688-bfdba93d4050"

    }

    详细参数请参见表4

    metric_name

    String

    指标名称,必须以字母开头,只能包含0-9/a-z/A-Z/_,长度最短为1,最大为64。

    表4 dimensions字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    name

    String

    监控维度名称,例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表,可参考维度中key字段。

    必须以字母开头,只能包含0-9/a-z/A-Z/_/-,长度最短为1,最大为32。

    value

    String

    维度取值,例如弹性云服务器的ID。

    必须以字母或数字开头,只能包含0-9/a-z/A-Z/_/-,长度最短为1,最大为256。

    • 对于dimensions字段的内容,可通过调用查询指标列表接口,在其响应体的相关指标数据中获取。
    • 对于OBS相关指标数据,当进行了相关OBS接口操作时可查询到相关指标数据,否则查询结果为空。
  • 请求样例
    请求样例一:查看弹性云服务器维度instance_id为faea5b75-e390-4e2b-8733-9226a9026070的监控数据disk_write_bytes_rate和弹性云服务器维度是instance_id为06b4020f-461a-4a52-84da-53fa71c2f42b的监控数据disk_write_requests_rate,在2019-04-30 20:00:00到2019-04-30 22:00:00时间内,原始数据的平均值。
    {
        "metrics": [
            {
                "namespace": "SYS.ECS",
                "dimensions": [
                    {
                        "name": "instance_id",
                        "value": "faea5b75-e390-4e2b-8733-9226a9026070"
                    }
                ],
                "metric_name": "disk_write_bytes_rate"
            },
            {
                "namespace": "SYS.ECS",
                "dimensions": [
                    {
                        "name": "instance_id",
                        "value": "06b4020f-461a-4a52-84da-53fa71c2f42b"
                    }
                ],
                "metric_name": "disk_write_requests_rate"
            }
        ],
        "from": 1556625600000,
        "to": 1556632800000,
        "period": "1",
        "filter": "average"
    }
    请求样例二:查看关系性数据库维度rds_cluster_id为3c8cc15614ab46f5b8743317555e0de2in01的监控数据rds021_myisam_buf_usage和关系性数据库维度是rds_cluster_id为3b2fa8b55a9b4adca3713962a9d31884in01的监控数据rds021_myisam_buf_usage,在2019-04-30 20:00:00到2019-04-30 22:00:00时间内,原始数据的求和值。
    {
        "metrics": [
            {
                "namespace": "SYS.RDS",
                "dimensions": [
                    {
                        "name": "rds_cluster_id",
                        "value": "3c8cc15614ab46f5b8743317555e0de2in01"
                    }
                ],
                "metric_name": "rds021_myisam_buf_usage"
            },
            {
                "namespace": "SYS.RDS",
                "dimensions": [
                    {
                        "name": "rds_cluster_id",
                        "value": "3b2fa8b55a9b4adca3713962a9d31884in01"
                    }
                ],
                "metric_name": "rds021_myisam_buf_usage"
            }
        ],
        "from": 1556625600000,
        "to": 1556632800000,
        "period": "1",
        "filter": "sum"
    }
    请求样例三:查看主机监控维度是instance_id为cd841102-f6b1-407d-a31f-235db796dcbb和proc为b28354b543375bfa94dabaeda722927f的监控数据proc_specified_count,在2019-04-30 20:00:00到2019-04-30 22:00:00时间内,周期为20分钟时,指标数据的最小值。
    {
        "metrics": [
            {
                "namespace": "AGT.ECS",
                "dimensions": [
                    {
                        "name": "instance_id",
                        "value": "cd841102-f6b1-407d-a31f-235db796dcbb"
                    },
                    {
                        "name": "proc",
                        "value": "b28354b543375bfa94dabaeda722927"
                    }
                ],
                "metric_name": "proc_specified_count"
            }
        ],
        "from": 1556625600000,
        "to": 1556632800000,
        "period": "1200",
        "filter": "min"
    }

响应消息

  • 响应参数
    表5 响应参数

    名称

    参数类型

    说明

    metrics

    Arrays of objects

    指标数据。

    详细参数请参见表6

    表6 metrics字段数据结构说明

    名称

    参数类型

    说明

    unit

    String

    指标单位。

    datapoints

    Arrays of objects

    指标数据列表。由于查询数据时,云监控会根据所选择的聚合粒度向前取整from参数,所以datapoints中包含的数据点有可能会多于预期。

    详细参数请参见表8

    namespace

    String

    指标命名空间,格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_,service.item总长度最短为3,最大为32。

    dimensions

    Arrays of objects

    指标维度列表。

    单个维度为json对象,结构说明如下:

    {

    "name": "instance_id",

    "value": "33328f02-3814-422e-b688-bfdba93d4050"

    }

    详细参数请参见表7

    metric_name

    String

    指标名称,必须以字母开头,只能包含0-9/a-z/A-Z/_,长度最短为1,最大为64。

    表7 dimensions字段数据结构说明

    名称

    参数类型

    说明

    name

    String

    监控维度名称,例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表,可参考维度中key字段。

    必须以字母开头,只能包含0-9/a-z/A-Z/_/-,长度最短为1,最大为32。

    value

    String

    维度取值,例如弹性云服务器的ID。

    必须以字母或数字开头,只能包含0-9/a-z/A-Z/_/-,长度最短为1,最大为256。

    表8 datapoints字段数据结构说明

    名称

    参数类型

    说明

    average

    double

    聚合周期内指标数据的平均值。

    max

    double

    聚合周期内指标数据的最大值。

    min

    double

    聚合周期内指标数据的最小值。

    sum

    double

    聚合周期内指标数据的求和值。

    variance

    double

    聚合周期内指标数据的方差。

    timestamp

    long

    指标采集时间,UNIX时间戳,单位毫秒。

  • 响应样例
    响应样例一:响应维度instance_id为faea5b75-e390-4e2b-8733-9226a9026070的弹性云服务器和维度是instance_id为06b4020f-461a-4a52-84da-53fa71c2f42b的弹性云服务器的监控数据cpu_util的平均值。
    {
        "metrics": [
            {
                "unit": "%",
                "datapoints": [
                    {
                        "average": 0.05,
                        "timestamp": 1484401920000
                    },
                    {
                        "average": 0.04,
                        "timestamp": 1484407920000
                    }
                ],
                "namespace": "SYS.ECS",
                "dimensions": [
                    {
                        "name": "instance_id",
                        "value": "faea5b75-e390-4e2b-8733-9226a9026070"
                    }
                ],
                "metric_name": "cpu_util"
            },
            {
                "unit": "%",
                "datapoints": [
                    {
                        "average": 0.08,
                        "timestamp": 1484401920000
                    },
                    {
                        "average": 0.07,
                        "timestamp": 1484407920000
                    }
                ],
                "namespace": "SYS.ECS",
                "dimensions": [
                    {
                        "name": "instance_id",
                        "value": "06b4020f-461a-4a52-84da-53fa71c2f42b"
                    }
                ],
                "metric_name": "cpu_util"
            }
        ]
    }
    响应样例二:响应维度rds_cluster_id为3c8cc15614ab46f5b8743317555e0de2in01的关系性数据库和维度是rds_cluster_id为3b2fa8b55a9b4adca3713962a9d31884in01的关系性数据库的监控数据rds021_myisam_buf_usage的求和值。
    {
        "metrics": [
            {
                "unit": "Ratio",
                "datapoints": [
                    {
                        "average": 0.07,
                        "timestamp": 1484401920000
                    },
                    {
                        "average": 0.07,
                        "timestamp": 1484407920000
                    }
                ],
                "namespace": "SYS.RDS",
                "dimensions": [
                    {
                        "name": "rds_cluster_id",
                        "value": "3c8cc15614ab46f5b8743317555e0de2in01"
                    }
                ],
                "metric_name": "rds021_myisam_buf_usage"
            },
            {
                "unit": "Ratio",
                "datapoints": [
                    {
                        "sum": 0.06,
                        "timestamp": 1484401920000
                    },
                    {
                        "sum": 0.07,
                        "timestamp": 1484407920000
                    }
                ],
                "namespace": "SYS.RDS",
                "dimensions": [
                    {
                        "name": "rds_cluster_id",
                        "value": "3b2fa8b55a9b4adca3713962a9d31884in01"
                    }
                ],
                "metric_name": "rds021_myisam_buf_usage"
            }
        ]
    }
    响应样例三:响应维度instance_id为cd841102-f6b1-407d-a31f-235db796dcbb和proc为b28354b543375bfa94dabaeda722927f的主机监控的监控数据proc_specified_count的最小值。
    {
        "metrics": [
            {
                "unit": "Ratio",
                "datapoints": [
                    {
                        "min": 0,
                        "timestamp": 1484401920000
                    },
                    {
                        "min": 0,
                        "timestamp": 1484407920000
                    }
                ],
                "namespace": "AGT.ECS",
                "dimensions": [
                    {
                        "name": "instance_id",
                        "value": "cd841102-f6b1-407d-a31f-235db796dcbb"
                    },
                    {
                        "name": "proc",
                        "value": "b28354b543375bfa94dabaeda722927f"
                    }
                ],
                "metric_name": "rds021_myisam_buf_usage"
            }
        ]
    }

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    未提供认证信息,或认证信息错误。

    403 Forbidden

    请求页面被禁止访问。

    408 Request Timeout

    请求超出了服务器的等待时间。

    429 Too Many Requests

    当前请求过多。

    500 Internal Server Error

    请求未完成,服务异常。

    503 Service Unavailable

    系统暂时不可用,请求受限。

错误码

请参考返回错误码说明

分享:

    相关文档

    相关产品