文档中心 云监控 API文档 各产品监控接口 负载均衡-负载均衡七层数据监控接口

负载均衡-负载均衡七层数据监控接口

最近更新时间:2019-07-10 16:50:30

1. 接口描述

接口:GetMonitorData
接口请求域名: monitor.tencentcloudapi.com

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

QCE/LB_PUBLIC:公网负载均衡命名空间,包括负载均衡维度和后端机器维度。 QCE/LB_PRIVATE:内网负载均衡命名空间,包括负载均衡维度监控数据。 QCE/LB_RS_PRIVATE:内网负载均衡命名空间,包括后端服务器维度的监控数据。 QCE/LOADBALANCE:负载均衡七层数据空间。

接口调用频率限制为:20次/秒,1200次/分钟。 单请求最多可支持批量拉取10个实例的监控数据,单请求的数据点数限制为1440个。

若您需要调用的指标、对象较多,可能存在因限频出现拉取失败的情况,建议尽量将请求按时间维度均摊。

查询公网负载均衡监控数据,是公网负载均衡对应的命名空间,您可以在此空间查询到公网负载均衡的所有监控数据。 支持以下4种维度组合的查询方式,四种入参取值如下:

1.1 负载均衡维度,入参取值如下:

&Namespace: QCE/LOADBALANCE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为 IP 地址

1.2 负载均衡端口维度,入参取值

&Namespace: QCE/LOADBALANCE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为 IP 地址
&Instances.N.Dimensions.1.Name=loadBalancerPort
&Instances.N.Dimensions.1.Value 为端口号
&Instances.N.Dimensions.2.Name=protocol
&Instances.N.Dimensions.2.Value 为协议类型

1.3 一个负载均衡的域名维度,入参取值

&Namespace: QCE/LOADBALANCE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为 IP 地址
&Instances.N.Dimensions.1.Name=loadBalancerPort
&Instances.N.Dimensions.1.Value 为端口号
&Instances.N.Dimensions.2.Name=protocol
&Instances.N.Dimensions.2.Value 为协议类型
&Instances.N.Dimensions.3.Name= domain
&Instances.N.Dimensions.3.Value 为域名

1.4 一个负载均衡的URL维度,入参取值

&Namespace: QCE/LOADBALANCE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为 IP 地址
&Instances.N.Dimensions.1.Name=loadBalancerPort
&Instances.N.Dimensions.1.Value 为端口号
&Instances.N.Dimensions.2.Name=protocol
&Instances.N.Dimensions.2.Value 为协议类型
&Instances.N.Dimensions.3.Name= domain
&Instances.N.Dimensions.3.Value 为域名
&Instances.N.Dimensions.3.Name= url
&Instances.N.Dimensions.3.Value 为域名下的URL

1.5 所有负载均衡的域名维度(若多个vip 共同使用一个域名,将全部聚合),入参取值

&Namespace: QCE/LOADBALANCE
&Instances.N.Dimensions.1.Name=loadBalancerPort
&Instances.N.Dimensions.1.Value 为端口号
&Instances.N.Dimensions.2.Name=protocol
&Instances.N.Dimensions.2.Value 为协议类型
&Instances.N.Dimensions.3.Name= domain
&Instances.N.Dimensions.3.Value 为域名

1.6 负载均衡后端服务器维度,入参取值

&Namespace: QCE/LOADBALANCE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为 IP 地址
&Instances.N.Dimensions.1.Name=loadBalancerPort
&Instances.N.Dimensions.1.Value 为端口号
&Instances.N.Dimensions.2.Name=protocol
&Instances.N.Dimensions.2.Value 为协议类型
&Instances.N.Dimensions.3.Name= vpcId
&Instances.N.Dimensions.3.Value 为负载均衡所在私有网络的 ID
&Instances.N.Dimensions.3.Name= domain
&Instances.N.Dimensions.3.Value 为域名
&Instances.N.Dimensions.3.Name= url
&Instances.N.Dimensions.3.Value 为域名下的URL
&Instances.N.Dimensions.4.Name=lanIp
&Instances.N.Dimensions.4.Value 为负载均衡绑定机器的 IP

1.7 负载均衡后端服务器端口维度,入参取值

&Namespace: QCE/LOADBALANCE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为 IP 地址
&Instances.N.Dimensions.1.Name=loadBalancerPort
&Instances.N.Dimensions.1.Value 为端口号
&Instances.N.Dimensions.2.Name=protocol
&Instances.N.Dimensions.2.Value 为协议类型
&Instances.N.Dimensions.3.Name= vpcId
&Instances.N.Dimensions.3.Value 为负载均衡所在私有网络的 ID
&Instances.N.Dimensions.3.Name= domain
&Instances.N.Dimensions.3.Value 为域名
&Instances.N.Dimensions.3.Name= url
&Instances.N.Dimensions.3.Value 为域名下的URL
&Instances.N.Dimensions.4.Name=lanIp
&Instances.N.Dimensions.4.Value 为负载均衡绑定机器的 IP
&Instances.N.Dimensions.5.Name=port
&Instances.N.Dimensions.5.Value 为负载均衡绑定机器的端口号

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 文档。

2.1 输入参数

2.1.1 输入参数总览

参数名称 是否必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData
Version String 公共参数,本接口取值: 2018-07-24
Region String 公共参数,表示查询的是哪个地域实例的监控数据;支持的地域可查看云服务器支持的 地域列表
Namespace String 命名空间,每个云产品会有一个命名空间,API 3.0接口版本的必须是大写,如:QCE/LOADBALANCE
MetricName String 指标名称,具体名称见2.2
Instances.N Array of Instance 实例对象的维度组合
Period Integer 监控统计周期。默认取值为300,单位为s
StartTime Timestamp 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00”
EndTime Timestamp 结束时间,默认为当前时间。 endTime 不能小于 startTime

2.1.2 各维度对应参数总览

参数名称 维度名称 维度解释 格式
&Instances.N.Dimensions.0.name vip 负载均衡 VIP String类型维度名称:vip
&Instances.N.Dimensions.0.value vip 负载均衡 VIP 具体ip地址,如111.111.111.11
&Instances.N.Dimensions.1.name loadBalancerPort 负载均衡端口 String类型维度名称:loadBalancerPort
&Instances.N.Dimensions.1.value loadBalancerPort 负载均衡端口 具体端口号,如80
&Instances.N.Dimensions.2.name protocol 协议 String类型维度名称:protocol
&Instances.N.Dimensions.2.value protocol 协议 string类型,如http
&Instances.N.Dimensions.3.name vpcId 负载均衡所在私有网络的 ID String类型维度名称:vpcId
&Instances.N.Dimensions.3.value vpcId 负载均衡所在私有网络的 ID 具体私有网络 ID,如1111
&Instances.N.Dimensions.4.name lanIp 负载均衡绑定机器的 IP String类型维度名称:lanIp
&Instances.N.Dimensions.4.value lanIp 负载均衡绑定机器的 IP 具体ip地址,如111.222.111.22
&Instances.N.Dimensions.5.name port 负载均衡绑定机器的端口号 String类型维度名称:port
&Instances.N.Dimensions.5.value port 负载均衡绑定机器的端口号 具体端口号,如80
&Instances.N.Dimensions.6.name domain 域名 String类型维度名称:domain
&Instances.N.Dimensions.6.value domain 域名 string类型,如www.123.com
&Instances.N.Dimensions.7.name url url String类型维度名称:url
&Instances.N.Dimensions.7.value url url string类型,如/aaa

2.2 指标名称

每个指标对应的统计粒度(Period)及维度(dimension)可取值不一定相同,可通过 DescribeBaseMetrics 接口获取每个指标支持的统计粒度及维度信息。

指标名称(metricName) 含义 单位
Connum 当前(活跃)连接数 个/分钟
NewConn 新增连接数 个/分钟
Intraffic 入流量 Mbps
Outtraffic 出流量 Mbps
Inpkg 入包量 个/秒
Outpkg 出包量 个/秒
HttpCode2XX 2xx 状态码 个/分钟
HttpCode3XX 3xx 状态码 个/分钟
HttpCode4XX 4xx 状态码 个/分钟
HttpCode5XX 5xx 状态码 个/分钟
HttpCode404 404 状态码 个/分钟
HttpCode502 502 状态码 个/分钟
ResponseTimeMax 最大响应时间 ms
ResponseTimeAverage 平均响应时间 ms
ResponseTimeoutNum 响应超时个数 个/分钟
QPS 每秒钟请求数

3. 输出参数

参数名称 类型 描述
MetricName String 监控指标
StartTime Timestamp 数据点起始时间
EndTime Timestamp 数据点结束时间
Period Integer 数据统计周期
DataPoints Array of PointsObject 监控数据列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId

4. 错误码表

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

5. 示例

示例1

拉取一个负载均衡某段时间内统计周期为300秒的QPS监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace= QCE/LOADBALANCE
&MetricName=QPS
&Period=300
&StartTime=2019-07-10T12:00:00+08:00
&EndTime=2019-07-10T12:59:59+08:00
&Instances.0.Dimensions.0.Name=vip
&Instances.0.Dimensions.0.Value=10.10.10.8
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-07-10 12:00:00",
    "EndTime": "2019-07-10 12:55:00",
    "Period": 300,
    "MetricName": "QPS",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "10.10.10.8"
          }
        ],
        "Timestamps": [
          1562731200,
          1562731500,
          1562731800,
          1562732100,
          1562732400,
          1562732700,
          1562733000,
          1562733300,
          1562733600,
          1562733900,
          1562734200,
          1562734500
        ],
        "Values": [
          0,
          0,
          100,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    ],
    "RequestId": "e5fef651-3858-41b8-93a2-6f312eec4423"
  }
}

示例2

拉取一个负载均衡某段时间内统计周期为300秒的HttpCode2XX监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace= QCE/LOADBALANCE
&MetricName=HttpCode2XX
&Period=300
&StartTime=2019-07-10T12:00:00+08:00
&EndTime=2019-07-10T12:59:59+08:00
&Instances.0.Dimensions.0.Name=vip
&Instances.0.Dimensions.0.Value=10.10.10.8
&Instances.0.Dimensions.1.Name=loadBalancerPort
&Instances.0.Dimensions.1.Value=8000
&Instances.0.Dimensions.2.Name=protocol
&Instances.0.Dimensions.2.Value=http
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-07-10 12:00:00",
    "EndTime": "2019-07-10 12:55:00",
    "Period": 300,
    "MetricName": "HttpCode2XX",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "loadBalancerPort",
            "Value": "8000"
          },
          {
            "Name": "protocol",
            "Value": "http"
          },
          {
            "Name": "vip",
            "Value": "10.10.10.8"
          }
        ],
        "Timestamps": [
          1562731200,
          1562731500,
          1562731800,
          1562732100,
          1562732400,
          1562732700,
          1562733000,
          1562733300,
          1562733600,
          1562733900,
          1562734200,
          1562734500
        ],
        "Values": [
          0,
          0,
          100,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    ],
    "RequestId": "5ebff8a6-7c57-42a5-8a24-a83da7cd1eb6"
  }
}