查询数据接口
所有文档

          云监控 BCM

          查询数据接口

          接口描述

          获取指定指标的一个或多个统计数据的时间序列数据。可获取云产品监控数据、站点监控数据或您推送的自定义监控数据。

          接口限制

          • 一次返回的数据点数目不能超过1440个。

          请求参数

          名称 类型 描述 是否必须 参数位置
          userId String 租户ID URL参数
          scope String,仅限于使用如下字符集合:"0~9、A~Z、a~z"、 "_" 名字空间 URL参数
          metricName String,仅限于使用如下字符集合:"0~9、A~Z、a~z"、 "_" 监控指标名 URL参数
          statistics Statistics,按照statistics1,statistics2,statistics3格式,可选值为average,maximum,minimum,sum,sampleCount 统计方法类型 Query参数
          dimensions String,由dimensionName:dimensionValue组成。当监控项具备多个维度时使用分号连接,例如dimensionName:dimensionValue;dimensionName:dimensionValue,相同维度只能指定一个维度值 维度列表 Query参数
          startTime DateTime,请参考日期与时间,UTC日期表示 查询起始时间 Query参数
          endTime DateTime,请参考日期与时间,UTC日期表示 查询截止时间 Query参数
          periodInSecond Integer,60的倍数,单位:秒(s) 统计周期 Query参数

          参数解释

          • 名字空间scope、监控项metric、统计方法Statistic、维度Dimension等的概念请参考核心概念

          响应参数

          名称 类型 描述
          requestId String 请求标识
          code String 返回码
          message String 错误信息
          dataPoints List(dataPoint) 监控指标

          dataPoint

          名称 类型 描述
          average double 统计周期内监控项的平均值
          sum double 统计周期内监控项的和值
          minimum double 统计周期内监控项的最小值
          maximum double 统计周期内监控项的最大值
          sampleCount Integer 统计周期内监控项数据点数
          timestamp DateTime,请参考日期与时间,UTC日期表示 监控项统计周期对应的时间

          请求示例

              # params definition
              enpoint = "bcm.bj.baidubce.com";
              userId = "fakeuser1ba678asdf8as7df6a5sdf67";
              ak = "ak";
              sk = "sk"
              scope = "BCE_BCC";
              metricName = "vCPUUsagePercent";
              dimensions = "InstanceId:fakeid-2222-8888-1111-13a8469b1fb2";
              statistics = new Statistics[]{Statistics.average,Statistics.maximum};
              startTime = "2019-04-16T13:55:01Z"
              endTime = "2019-04-16T14:00:01Z"
              periodInSecond = 60
          
              # create a bcm client
              BcmClientConfiguration config = new BcmClientConfiguration();
              config.setCredentials(new DefaultBceCredentials(ak, sk));
              config.setEndpoint(enpoint);
              bcmClient = new BcmClient(config);
          
              # query metric data from bcm interface
              MetricDataRequest request = new MetricDataRequest();
                  request.withUserId(userId)
                          .withScope(scope)
                          .withDimensions(dimensions)
                          .withMetricName(metricName)
                          .withStatistics(statistics)
                          .withStartTime(startTime)
                          .withEndTime(endTime)
                          .withPeriodInSecond(periodInSecond);
               MetricDataResponse response = bcmClient.getMetricData(request);
              
          上一篇
          BcmClient
          下一篇
          Python-SDK