批量查询数据接口
更新时间:2023-01-06
接口描述
可获取批量实例数据的接口,支持多维度多指标查找。可获取云产品监控数据、站点监控数据或您推送的自定义监控数据。
接口限制
• 一个实例的任意一个指标一次返回的数据点数目不能超过1440个。
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
userId | String | 租户ID | 是 | URL参数 |
scope | String,仅限于使用如下字符集合:"0~9、A~Z、a~z"、 "_" | 名字空间 | 是 | URL参数 |
metricName | String,仅限于使用如下字符集合:"0~9、A~Z、a~z"、 "_" 当需要查找多个指标项时,使用String数组存储,每个数组元素为一个指标项 |
监控指标名 | 是 | Query参数 |
statistics | Statistics,按照statistics1,statistics2,statistics3格式,可选值为average,maximum,minimum,sum,sampleCount | 统计方法类型 | 是 | Query参数 |
dimensions | String,由dimensionName:dimensionValue组成。当监控项具备多个维度时使用分号连接,例如dimensionName:dimensionValue;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
String ACCESS_KEY_ID = "your ak";
String SECRET_ACCESS_KEY = "your sk";
String ENDPOINT = "http://bj.bcm.baidubce.com";
String userId = "your userid";
String scope ="BCE_BCC";
String dimensions = "InstanceId:fake-1-test,InstanceId:fake-2-test";
String startTime ="2023-01-03T02:43:07Z";
String endTime ="2023-01-03T03:43:07Z";
Statistics[] statistics = {Statistics.average, Statistics.maximum};
String[] metrics = {"CPUUsagePercent", "WebOutBytes"};
int periodInSecond = 60;
# create a bcm client
BcmClientConfiguration config = new BcmClientConfiguration();
config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
config.setEndpoint(ENDPOINT);
BcmClient client = new BcmClient(config);
ListMetricDataRequest request = new ListMetricDataRequest();
request.withUserId(userId)
.withScope(scope)
.withDimensions(dimensions)
.withMetricNames(metrics)
.withPeriodInSecond(periodInSecond)
.withStartTime(startTime)
.withEndTime(endTime)
.withStatistics(statistics);
# get batch metric data
ListMetricDataResponse metricData = client.getMetricData(request);