公网负载均衡监控接口-腾讯云可观测平台-文档中心-腾讯云

1. 接口描述

域名：monitor.api.qcloud.com
接口：GetMonitorData

负载均衡（Cloud Load Balancer）是对多台云服务器进行流量分发的服务。具体介绍请参考负载均衡简介页面。
当前负载均衡支持三种命名空间 qce/lb_public、qce/lb_private 和 qce/lb_rs_private。

qce/lb_public：公网负载均衡命名空间，包括负载均衡维度和后端机器维度。
qce/lb_private：内网负载均衡命名空间，包括负载均衡维度监控数据。
qce/lb_rs_private：内网负载均衡命名空间，包括后端服务器维度的监控数据。

查询公网负载均衡监控数据，qce/lb_public 是公网负载均衡对应的命名空间，您可以在此空间查询到公网负载均衡的所有监控数据。

qce/lb_public 支持以下4种维度组合的查询方式，四种入参取值如下：

1.1 公网负载均衡维度，入参取值

namespace: qce/lb_public
dimensions.0.name=vip
dimensions.0.value 为 IP 地址

1.2 公网负载均衡端口维度，入参取值

namespace: qce/lb_public
dimensions.0.name=vip
dimensions.0.value 为 IP 地址
&dimensions.1.name=loadBalancerPort
&dimensions.1.value 为端口号
&dimensions.2.name=protocol
&dimensions.2.value 为协议类型

1.3 公网负载均衡后端服务器维度，入参取值

&namespace=qce/lb_public
&dimensions.0.name=vip
&dimensions.0.value 为 IP 地址
&dimensions.1.name=loadBalancerPort
&dimensions.1.value 为端口号
&dimensions.2.name=protocol
&dimensions.2.value 为协议类型
&dimensions.3.name=vpcId
&dimensions.3.value 为负载均衡所在私有网络的 ID
&dimensions.4.name=lanIp
&dimensions.4.value 为负载均衡绑定机器的 IP

1.4 公网负载均衡后端服务器端口维度，入参取值

2. 输入参数

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

2.1 输入参数

2.1.1 输入参数总览

参数名称	必选	类型	输入内容	描述
namespace	是	String	qce/cvm	命名空间，每个云产品会有一个命名空间，具体名称见输入内容一栏。
metricName	是	String	具体的指标名称	指标名称，具体名称见2.2
dimensions.n.name	是	String	维度的名称	维度的名称，具体维度名称见第2.1.2小节，与dimensions.n.value配合使用。
dimensions.n.value	是	String	对应的维度的值	对应的维度的值，具体维度名称见第2.1.2小节，与dimensions.n.name配合使用。
period	否	Int	60/300	监控统计周期，绝大部分指标支持60s统计粒度，部分指标仅支持300s统计粒度，统计粒度根据指标的不同而变。输入参数时可参考2.2的指标详情列表。
startTime	否	Datetime	起始时间	起始时间，如 “2016-01-01 10:25:00”。默认时间为当天的 “00:00:00”
endTime	否	Datetime	结束时间	结束时间，默认为当前时间。 endTime 不能小于 startTime

2.1.2 各维度对应参数总览

参数名称	维度名称	维度解释	格式
dimensions.0.name	vip	负载均衡 VIP	String 类型维度名称：vip
dimensions.0.value	vip	负载均衡 VIP	具体 IP 地址，如111.111.111.11
dimensions.1.name	loadBalancerPort	负载均衡端口	String 类型维度名称：loadBalancerPort
dimensions.1.value	loadBalancerPort	负载均衡端口	具体端口号，如80
dimensions.2.name	protocol	协议	String 类型维度名称：protocol
dimensions.2.value	protocol	协议	String 类型，如 http
dimensions.3.name	vpcId	负载均衡所在私有网络的 ID	String 类型维度名称：vpcId
dimensions.3.value	vpcId	负载均衡所在私有网络的 ID	具体私有网络 ID，如1111
dimensions.4.name	lanIp	负载均衡绑定机器的 IP	String类型维度名称：lanIp
dimensions.4.value	lanIp	负载均衡绑定机器的 IP	具体 IP 地址，如111.111.111.11
dimensions.5.name	port	负载均衡绑定机器的端口号	String 类型维度名称：port
dimensions.5.value	port	负载均衡绑定机器的端口号	具体端口号，如80

2.2 指标名称

指标名称（metricName）	含义	单位
connum	当前连接数	个
new_conn	新增连接数	个
intraffic	入流量	Mbps
outtraffic	出流量	Mbps
inpkg	入包量	个/s
outpkg	出包量	个/s

3. 输出参数

参数名称	类型	描述
code	Int	错误码，0：成功，其他值表示失败
message	String	返回信息
startTime	Datetime	起始时间
endTime	Datetime	结束时间
metricName	String	指标名称
period	Int	监控统计周期
dataPoints	Array	监控数据列表

4. 错误码表

错误代码	错误描述	英文描述
-502	资源不存在	OperationDenied.SourceNotExists
-503	请求参数有误	InvalidParameter
-505	参数缺失	InvalidParameter.MissingParameter
-507	超出限制	OperationDenied.ExceedLimit
-509	错误的维度组合	InvalidParameter.DimensionGroupError
-513	DB 操作失败	InternalError.DBoperationFail

5. 示例

输入

https://monitor.api.qcloud.com/v2/index.php?
&公共请求参数
&namespace=qce/lb_public
&metricName=intraffic
&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=http
&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
&startTime=2016-06-28 14:10:00
&endTime=2016-06-28 14:20:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "intraffic",
    "startTime": "2016-06-28 14:10:00",
    "endTime": "2016-06-28 14:20:00",
    "period": 300,
    "dataPoints": [
        5.6,
        6.5,
        7.7
    ]
}

公网负载均衡监控接口

本页目录：