当前位置：主页 > 查看内容

负载均衡负载均衡监控接口 - API 文档

发布时间：2021-09-24 00:00| 有位朋友查看

简介：接口描述 GetMonitorData 接口提供了获取负载均衡的监控数据功能。可以根据用户传入的负载均衡命名空间、对象纬度描述和监控指标即可获得相应的监控数据。接口访问域名： monitor.api.qcloud.com 请求参数以下请求参数列表仅列出了接口请求参数，正式调用……

接口描述

GetMonitorData 接口提供了获取负载均衡的监控数据功能。可以根据用户传入的负载均衡命名空间、对象纬度描述和监控指标即可获得相应的监控数据。

接口访问域名：monitor.api.qcloud.com

请求参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，详情请参见公共请求参数。其中，此接口的 Action 字段为 GetMonitorData。

参数名称	必选	类型	描述
namespace	是	String	命名空间，每个云产品会有一个命名空间。负载均衡共有两个命名空间：qce/lb_public、qce/lb_private，其中，qce/lb_public 是公网属性负载均衡命名空间，qce/lb_private 是内网负载均衡命名空间。
metricName	是	String	指标名称，想要获取的具体监控指标，如当前连接数是 connum，入带宽是 intraffic 具体如下表。
dimensions.n.name	是	String	纬度的名称，多个维度组合起来得到具体的监控数据。每个命名空间的纬度结构不同。具体纬度接口可见下面的表格，与 dimensions.n.value 配合使用。
dimensions.n.value	是	String	相应纬度名称对应的值。
startTime	否	Datetime	起始时间，如“2017-01-01 00:00:00”。默认时间为当天的”00:00:00”。
endTime	否	Datetime	结束时间，如”2017-01-01 10:00:00”。默认为当前时间。注意：endTime 不能小于 startTime，且 endTime 与 startTime 最好为同一天。
period	否	Int	监控统计周期。当前支持60s和300s两种粒度，如不传，默认使用300s粒度。

当前负载均衡可展示的指标（metricName）列表如下：

指标名称	含义	单位
connum	当前连接数	个
new_conn	新增连接数	个
intraffic	入带宽	Mbps
outtraffic	出带宽	Mbps
inpkg	入包量	个/秒
outpkg	出包量	个/秒

当前负载均衡支持的命名空间以及各自的监控维度说明如下：

公网负载均衡命名空间 qce/lb_public

qce/lb_public 是公网负载均衡对应的命名空间，您可以在此空间查询到公网负载均衡的所有监控数据。
qce/lb_public 支持以下几种维度组合：

公网负载均衡维度
此维度体现的是一个公网负载均衡器的整体监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数 >
&namespace=qce/lb_public
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11

公网负载均衡端口维度
此维度体现的是一个公网负载均衡器端口的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
loadBalancerPort	端口	int 类型，如80
protocol	协议	String 类型，如 TCP

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数 >
&namespace=qce/lb_public
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=loadBalancerPort
&dimensions.1.value=80
&dimensions.2.name=protocol
&dimensions.2.value=tcp

公网负载均衡后端服务器维度
此维度体现的是一个公网负载均衡所绑定的后端服务器的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
loadBalancerPort	负载均衡端口	int 类型，如80
protocol	协议	String 类型，如 TCP
vpcId	负载均衡所在私有网络的 ID	int 类型，如1111
lanIp	负载均衡绑定机器的 IP	IP 地址类型，如111.111.111.11

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数 >
&namespace=qce/lb_public
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=loadBalancerPort
&dimensions.1.value=80
&dimensions.2.name=protocol
&dimensions.2.value=tcp
&dimensions.3.name=vpcId
&dimensions.3.value=1111
&dimensions.4.name=lanIp
&dimensions.4.value=111.222.111.22

公网负载均衡后端服务器端口维度
此维度体现的是一个公网负载均衡所绑定的后端服务器某个端口的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
loadBalancerPort	负载均衡端口	int 类型，如80
protocol	协议	String类型，如 TCP
vpcId	负载均衡所在私有网络的 ID	int 类型，如1111
lanIp	负载均衡绑定机器的 IP	IP 地址类型，如111.111.111.11
port	负载均衡绑定机器的端口号	int 类型，如80

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数 >
&namespace=qce/lb_public
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=loadBalancerPort
&dimensions.1.value=80
&dimensions.2.name=protocol
&dimensions.2.value=tcp
&dimensions.3.name=vpcId
&dimensions.3.value=1111
&dimensions.4.name=lanIp
&dimensions.4.value=111.222.111.22
&dimensions.5.name=port
&dimensions.5.value=80

内网属性负载均衡维度命名空间 qce/lb_private

qce/lb_private，您可以在此空间查询到内网负载均衡维度相关监控数据。

内网负载均衡维度
此维度体现的是一个内网负载均衡器的整体监控指标，需要传入的维度（dimensions.n.name）如下，由于内网 VIP 有可能重复，所以还需要传入 vpcId 才能唯一指定一个 lb：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
vpcId	负载均衡所在私有网络的 ID	int 类型，如1111

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/lb_private
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=vpcId
&dimensions.1.value=1111

内网负载均衡端口维度
此维度体现的是一个内网负载均衡器端口的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
vpcId	负载均衡所在私有网络的 ID	int 类型，如1111
loadBalancerPort	负载均衡端口	int 类型，如80
protocol	协议	String类型，如 http

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/lb_private
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=vpcId
&dimensions.1.value=1111
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=protocol
&dimensions.3.value=http

内网负载均衡后端机器维度
此维度体现的是一个内网负载均衡绑定的后端机器的监控指标，需要传入的维度（dimensions.n.name）如下，由于内网 VIP 有可能重复，所以还需要传入 vpcId 才能唯一指定一个 lb：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
vpcId	负载均衡所在私有网络的 ID	int 类型，如1111
loadBalancerPort	负载均衡端口	int 类型，如80
protocol	协议	String 类型，如 http
lanIp	负载均衡绑定机器 IP	IP 地址类型，如111.111.111.11

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/lb_private
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=vpcId
&dimensions.1.value=1111
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=protocol
&dimensions.3.value=http
&dimensions.4.name=lanIp
&dimensions.4.value=111.222.111.22

内网负载均衡后端机器端口维度
此维度体现的是内网负载均衡绑定的后端机器的某个端口监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
vpcId	负载均衡所在私有网络的 ID	int 类型，如1111
loadBalancerPort	负载均衡端口	int 类型，如80
protocol	协议	string 类型，如 http
lanIp	负载均衡绑定机器 IP	IP 地址类型，如111.111.111.11
port	负载均衡绑定机器 port	int 类型，如80

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/lb_private
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=vpcId
&dimensions.1.value=1111
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=protocol
&dimensions.3.value=http
&dimensions.4.name=lanIp
&dimensions.4.value=111.222.111.22
&dimensions.5.name=port
&dimensions.5.value=80

负载均衡维度命名空间 qce/loadbalance（新）

qce/loadbalance 是负载均衡对应的命名空间，您可以在此空间查询到负载均衡的应用层的相关监控数据。

当前命名空间负载均衡可展示的指标（metricName）列表如下：

指标名称	含义	单位
connum	当前（活跃）连接数	个/分钟
new_conn	新增连接数	个/分钟
intraffic	入流量	Mbps
outtraffic	出流量	Mbps
inpkg	入包量	个/秒
outpkg	出包量	个/秒
httpCode_2XX	2xx 状态码	个/分钟
httpCode_3XX	3xx 状态码	个/分钟
httpCode_4XX	4xx 状态码	个/分钟
httpCode_5XX	5xx 状态码	个/分钟
httpCode_404	404 状态码	个/分钟
httpCode_502	502 状态码	个/分钟
response_time_max	最大响应时间	ms
response_time_average	平均响应时间	ms
response_timeout_num	响应超时个数	个/分钟
QPS	每秒钟请求数	个

qce/loadbalance 支持以下维度组合：

负载均衡 VIP 维度
此维度体现的是一个负载均衡器的整体监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/loadbalance
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11

负载均衡监听器端口维度
此维度体现的是一个负载均衡器端口的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
loadBalancerPort	端口	int 类型，如80
protocol	协议	String类型，如 http

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/loadbalance
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=protocol
&dimensions.3.value=http

负载均衡转发域名维度
此维度体现的是一个负载均衡器转发域名的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
loadBalancerPort	端口	int 类型，如80
protocol	协议	String类型，如 http
domain	转发域名	String类型，如 www.domain.com

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/loadbalance
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=domain
&dimensions.1.value=www.domian.com
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=protocol
&dimensions.3.value=http

负载均衡转发路径维度
此维度体现的是一个负载均衡器转发路径的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如 111.111.111.11
loadBalancerPort	端口	int 类型，如 80
protocol	协议	String 类型，如 http
domain	转发域名	String 类型，如 www.domain.com
url	转发路径	String类型，如/url

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/loadbalance
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=domain
&dimensions.1.value=www.domian.com
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=protocol
&dimensions.3.value=http
&dimensions.3.name=url
&dimensions.3.value=/url

负载均衡后端 IP 维度
此维度体现的是一个负载均衡器后端 IP 的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
loadBalancerPort	端口	int 类型，如80
protocol	协议	String 类型，如 http
domain	转发域名	String类型，如 www.domain.com
url	转发路径	String 类型，如 /url
vpcId	负载均衡所在私有网络的 ID	int 类型，如1111
lanIp	负载均衡绑定机器的 IP	IP 地址类型，如111.111.111.11

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/loadbalance
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=vpcId
&dimensions.1.value=1111
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=protocol
&dimensions.3.value=http
&dimensions.4.name=lanIp
&dimensions.4.value=111.222.111.22
&dimensions.1.name=domain
&dimensions.1.value=www.domian.com
&dimensions.3.name=url
&dimensions.3.value=/url

负载均衡后端端口维度
此维度体现的是一个负载均衡器后端端口的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
VIP	负载均衡 VIP	IP 地址类型，如111.111.111.11
loadBalancerPort	端口	int 类型，如80
protocol	协议	String 类型，如http
domain	转发域名	String类型，如 www.domain.com
url	转发路径	String类型，如/url
vpcId	负载均衡所在私有网络 ID	int 类型，如1111
lanIp	负载均衡绑定机器的 IP	IP 地址类型，如111.111.111.11
port	负载均衡绑定机器的端口号	int 类型，如80

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/loadbalance
&metricName=connum
&dimensions.0.name=vip
&dimensions.0.value=111.111.111.11
&dimensions.1.name=vpcId
&dimensions.1.value=1111
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&dimensions.3.name=protocol
&dimensions.3.value=http
&dimensions.4.name=lanIp
&dimensions.4.value=111.222.111.22
&dimensions.5.name=port
&dimensions.5.value=80
&dimensions.1.name=domain
&dimensions.1.value=www.domian.com
&dimensions.3.name=url
&dimensions.3.value=/url

返回参数

参数名称	类型	描述
code	Int	公共错误码，0表示成功，其他值表示失败。详见错误码页面的公共错误码。
codeDesc	String	英文错误码。
message	String	错误信息详细描述。
startTime	Datetime	起始时间。
endTime	Datetime	结束时间。
metricName	String	指标名称。
period	Int	监控统计周期。
dataPoints	Object	监控数据列表。数组每个元素是监控点数据。

示例

请求


https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/lb_public
&metricName=connum
&dimensions.0.name=protocol
&dimensions.0.value=HTTP
&dimensions.1.name=vip
&dimensions.1.value=111.111.111.111
&dimensions.2.name=loadBalancerPort
&dimensions.2.value=80
&startTime=2015-12-28 14:00:00
&endTime=2015-12-28 14:05:00
&period=300

{
    "code": 0,
    "message": "",
    "metricName": "connum",
    "startTime": "2015-12-28 14:00:00",
    "endTime": "2015-12-28 14:05:00",
    "period": 300,
    "dataPoints":  [
           0
        ]
}

转发域名维度
此维度体现的是一个或者多个负载均衡器同时设置了一个转发域名的监控指标，需要传入的维度（dimensions.n.name）如下：

维度	维度解释	格式
loadBalancerPort	端口	int 类型，如80
protocol	协议	String类型，如 http
domain	转发域名	String类型，如 www.domain.com

此维度调用方式示例：

https://monitor.api.qcloud.com/v2/index.php?Action=GetMonitorData
&<公共请求参数>
&namespace=qce/loadbalance
&metricName=QPS
&dimensions.0.name=domain
&dimensions.0.value=www.domian.com
&dimensions.1.name=loadBalancerPort
&dimensions.1.value=80
&dimensions.2.name=protocol
&dimensions.2.value=http

本站部分内容转载于网络，版权归原作者所有，转载之目的在于传播更多优秀技术内容，如有侵权请联系QQ/微信：153890879删除，谢谢！

上一篇：DescribeNotificationConfigurations - 弹性伸缩 下一篇：没有了

负载均衡负载均衡监控接口 - API 文档

接口描述

请求参数

公网负载均衡命名空间 qce/lb_public

内网属性负载均衡维度命名空间 qce/lb_private

负载均衡维度命名空间 qce/loadbalance（新）

返回参数

示例

推荐图文

MQTT X连接阿里云微服务消息队列MQTT

【观点分享】低代码平台是“业务上云”走向万千企业

友邦人寿引入阿里云PolarDB云数据库支撑保险业务

阿里云云码广告联盟高效助力中小App流量变现

云服务器实例计费问题 - 常见问题

数据湖实操讲解【OSS 访问加速】第七讲：Flink 高效

随机推荐

大数据经验谈：新冠疫情教给我们的五点启

大数据就是泡沫！除了报表和取数，它还能

微服务中的重要的组件Metrics

“有喵”获数百万元天使融资！官网双拼域

大数据无处不在如何将数据转化为行动和

中国信通院组织召开IHIA医疗健康大数据产

行业场景智能应用解锁边缘计算时代新机

域名哪个需实名

【Web Function】实战使用：PHP Web函数

备份数据可以下载至本地吗？_云备份 CBR_

关于我们

负载均衡 负载均衡监控接口 - API 文档

接口描述

请求参数

公网负载均衡命名空间 qce/lb_public

内网属性负载均衡维度命名空间 qce/lb_private

负载均衡维度命名空间 qce/loadbalance（新）

返回参数

示例

推荐图文

随机推荐

关于我们

负载均衡负载均衡监控接口 - API 文档