部分维度查询最新指标数据
接口描述
可根据多维度、多指标、多统计数据获取云产品指定时刻指标监控数据、站点监控数据或您推送的自定义监控数据。
接口限制
- 每次查询的维度组合数量不超过100个。
- 每次查询的指标名称数量不超过30个。
请求结构
- 请求方法:POST
- 请求URL:/csm/api/v2/userId/{userId}/services/{scope}/data/metricData/latest/batch
请求参数
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
userId |
String |
用户ID |
是 |
Body参数 |
scope |
String |
云产品标识,取值请参考云产品标识列表 |
是 |
Body参数 |
region |
String |
区域标识,取值请参考区域列表 |
是 |
Body参数 |
resourceType |
String |
监控对象类型,默认值:Instance,取值请参考云产品监控对象类型列表 |
否 |
Body参数 |
metricNames |
List<String> |
监控指标列表 |
是 |
Body参数 |
statistics |
List<String> |
统计方法类型列表,可选值:average、maximum、minimum、sum、sampleCount。为空时默认返回最新原始值 |
否 |
Body参数 |
dimensions |
List<Dimension> |
维度列表 |
否 |
Body参数 |
cycle |
int |
统计周期,单位:秒,默认为60,上限为3600 |
否 |
Body参数 |
timestamp |
DateTime |
监控项统计周期对应的时间,默认为当前时间。请参考日期与时间,UTC日期表示 |
是 |
Body参数 |
Dimension
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
name |
String |
维度key |
是 |
Body参数 |
value |
String |
维度value |
是 |
Body参数 |
参数解释
-云产品标识scope、监控项metric、统计方法Statistic、维度Dimension等概念请参考核心概念。
响应参数
名称 |
类型 |
描述 |
requestId |
String |
请求标识 |
code |
String |
返回码 |
message |
String |
错误信息 |
metrics |
List<AllDataMetric> |
监控指标 |
AllDataMetric
名称 |
类型 |
描述 |
region |
String |
区域标识 |
scope |
String |
云产品标识 |
userId |
String |
用户ID |
resourceId |
String |
资源id |
metricName |
String |
指标名 |
dimensions |
List<Dimensions> |
维度列表 |
dataPoints |
List<DataPoint> |
监控指标数据 |
DataPoint
名称 |
类型 |
描述 |
average |
double |
统计周期内监控项的平均值 |
sum |
double |
统计周期内监控项的和值 |
minimum |
double |
统计周期内监控项的最小值 |
maximum |
double |
统计周期内监控项的最大值 |
sampleCount |
int |
统计周期内监控项数据点数 |
value |
int |
统计周期内监控项的原始值 |
timestamp |
DateTime |
监控项统计周期对应的时间,请参考日期与时间,UTC日期表示 |
请求示例
String endpoint = "http://bcm.bj.baidubce.com";
String userId = "a0d04d7c***************7b6752ce4";
String ak = "ALTAK***************3hVCYG";
String sk = "b2c53*******************f9993ac1";
BcmClientConfiguration config = new BcmClientConfiguration();
config.setCredentials(new DefaultBceCredentials(ak, sk));
config.setEndpoint(endpoint);
BcmClient bcmClient = new BcmClient(config);
MultiDimensionalLatestMetricsRequest request = new MultiDimensionalLatestMetricsRequest();
ArrayList<String> metrics = new ArrayList<String>();
metrics.add("ActiveConnCount");
ArrayList<Dimension> dimensions = new ArrayList<Dimension>();
dimensions.add(new Dimension("BlbId", "lb-0f8e****"));
request.setUserId(userId);
request.setScope("BCE_BLB");
request.setMetricNames(metrics);
request.setDimensions(dimensions);
MultiDimensionalLatestMetricsResponse res = bcmClient.getMultiDimensionalLatestMetrics(request);
返回结果
{
"metadata" : {
"bceRequestId" : "71b8b65a-7b09-4811-a71a-bf6d937c762c",
"transferEncoding" : "chunked",
"contentLength" : -1,
"contentType" : "application/json;charset=UTF-8",
"date" : 1713151664000
},
"requestId" : "71b8b65a-7b09-4811-a71a-bf6d937c762c",
"code" : "success",
"metrics" : [ {
"region" : "bj",
"scope" : "BCE_BLB",
"userId" : "a0d04d7c***************7b6752ce4",
"resourceId" : "lb-0f8e****",
"metricName" : "ActiveConnCount",
"dimensions" : [ {
"name" : "BlbId",
"value" : "lb-0f8e****"
}, {
"name" : "BlbPort",
"value" : "27017"
}, {
"name" : "BlbPortType",
"value" : "TCP"
} ],
"dataPoints" : [ {
"value" : 0.0,
"timestamp" : "2024-04-15T03:27:44Z"
} ]
}, {
"region" : "bj",
"scope" : "BCE_BLB",
"userId" : "a0d04d7c***************7b6752ce4",
"resourceId" : "lb-0f8e****",
"metricName" : "ActiveConnCount",
"dimensions" : [ {
"name" : "BlbId",
"value" : "lb-0f8e****"
} ],
"dataPoints" : [ {
"value" : 0.0,
"timestamp" : "2024-04-15T03:27:44Z"
} ]
} ]
}