负载均衡
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 负载均衡 > API 文档 > 负载均衡 API 2017 > 通用接口 > 负载均衡监控接口

负载均衡监控接口

最近更新时间：2023-07-18 14:25:36

前往 GitHub 编辑 我的收藏

本页目录：

接口描述

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 配合使用。
说明

当CLB后端服务为SCF云函数时，请按照如下要求传参，否则获取不到监控数据：

  • lanip（负载均衡绑定机器的 IP）需传入“SCF 命名空间/SCF 函数名/SCF 版本或别名”，注意，此处为变量，请根据 SCF 实际信息填写。
  • port（负载均衡绑定机器的端口号）需传入0。
    • 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

    返回参数

    参数名称 类型 描述
    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
    中国站