接口描述
可根据多维度、多指标、多统计数据获取云产品指定时刻指标监控数据、站点监控数据或您推送的自定义监控数据。
接口限制
- 每次查询的维度组合数量不超过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日期表示 |
请求示例
// config of client
HOST = 'http://bcm.bj.baidubce.com/'
AK = 'ALTA****************3hVCYG'
SK = 'b2c53***********************3ac1'
config = BceClientConfiguration(credentials=BceCredentials(AK, SK), endpoint=HOST)
user_id = "a0d04d7c***************7b6752ce4"
scope = "BCE_BLB"
metric_name = ["ActiveConnCount", "DropOutBytes"]
dimensions = [{"name": "BlbId", "value": "lb-0f8e****"}]
statistics = ["average","sum","minimum"]
timestamp="2024-04-15T03:01:00Z"
bcm_client = BcmClient(config)
res = self.client.get_multi_dimension_latest_metrics(user_id,
scope,
metric_names,
statistics,
dimensions,
timestamp)
返回结果
{
"metadata": {
"date": "Mon, 15 Apr 2024 03:50:02 GMT",
"x_trace_id": "19c116bd-e046-433a-af2a-47a705c66150",
"x_trace_timestamp": "1713153002988",
"x_trace_consumer_ip": "172.18.64.107",
"x_trace_provider_ip": "10.211.83.158",
"x_application_context": "application:8869",
"x_user_request_id": "e2287076-589e-492d-83d3-79585343f4f7",
"x_protected_by": "OpenRASP 2.0",
"bce_request_id": "fd53de57-334e-437d-b301-652152c987e1",
"x_b3_traceid": "fd53de57334e437db301652152c987e1",
"cache_control": "no-cache",
"responsehostnamesting": "szth-bcm-online-00006.szth.baidu.com",
"responsehostip": "10.174.228.36",
"x_content_type_options": "nosniff",
"x_xss_protection": "1; mode=block",
"x_frame_options": "DENY",
"content_type": "application/json;charset=UTF-8",
"transfer_encoding": "chunked"
},
"request_id": "fd53de57-334e-437d-b301-652152c987e1",
"code": "success",
"message": None,
"metrics": [
{
"region": "bj",
"scope": "BCE_BLB",
"user_id": "a0d04d7c***************7b6752ce4",
"resource_id": "lb-0f8e9bad",
"metric_name": "ActiveConnCount",
"dimensions": [
{"name": "BlbId", "value": "lb-0f8e9bad"},
{"name": "BlbPort", "value": "27017"},
{"name": "BlbPortType", "value": "TCP"}
],
"data_points": [{"average": 0.0, "sum": 0.0, "minimum": 0.0, "timestamp": "2024-04-15T03:01:00Z"}]
},
{
"region": "bj",
"scope": "BCE_BLB",
"user_id": "a0d04d7c***************7b6752ce4",
"resource_id": "lb-0f8e9bad",
"metric_name": "DropOutBytes",
"dimensions": [
{"name": "BlbId", "value": "lb-0f8e9bad"},
{"name": "BlbPort", "value": "27017"},
{"name": "BlbPortType", "value": "TCP"}
],
"data_points": [{"average": 0.0, "sum": 0.0, "minimum": 0.0, "timestamp": "2024-04-15T03:01:00Z"}]
},
{
"region": "bj",
"scope": "BCE_BLB",
"user_id": "a0d04d7c***************7b6752ce4",
"resource_id": "lb-0f8e9bad",
"metric_name": "ActiveConnCount",
"dimensions": [{"name": "BlbId", "value": "lb-0f8e9bad"}],
"data_points": [{"average": 0.0, "sum": 0.0, "minimum": 0.0, "timestamp": "2024-04-15T03:01:00Z"}]
}
]
}
