文档中心 云监控 API文档 各产品监控接口 负载均衡-内网负载均衡(后端服务器维度)监控接口

负载均衡-内网负载均衡(后端服务器维度)监控接口

最近更新时间:2019-08-16 22:38:53

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个。

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

QCE/LB_RS_PRIVATE是内网负载均衡后端服务器维度的命名空间,您可以在此空间查询到内网负载均衡后端服务器维度相关监控数据。 QCE/LB_RS_PRIVATE支持以下2种维度组合的查询方式,四种入参取值如下:

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

由于内网vip有可能重复,所以还需要传入vpcId才能唯一指定一个lb:
&Namespace= QCE/LB_RS_PRIVATE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value为 IP 地址
&Instances.N.Dimensions.1.Name=vpcId
&Instances.N.Dimensions.1.Value为负载均衡所在私有网络的 ID
&Instances.N.Dimensions.2.Name=loadBalancerPort
&Instances.N.Dimensions.2.Value 为端口号
&Instances.N.Dimensions.3.Name=protocol
&Instances.N.Dimensions.3.Value 为协议类型
&Instances.N.Dimensions.4.Name=lanIp
&Instances.N.Dimensions.4.Value 为负载均衡绑定机器的 IP

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

由于内网vip有可能重复,所以还需要传入 vpcId 才能唯一指定一个lb:

&Namespace= QCE/LB_RS_PRIVATE
&Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value为 IP 地址
&Instances.N.Dimensions.1.Name=vpcId
&Instances.N.Dimensions.1.Value 为负载均衡所在私有网络的 ID
&Instances.N.Dimensions.2.Name=loadBalancerPort
&Instances.N.Dimensions.2.Value 为端口号
&Instances.N.Dimensions.3.Name=protocol
&Instances.N.Dimensions.3.Value 为协议类型
&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/LB_RS_PRIVATE
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 vpcId 负载均衡所在私有网络的 ID String 类型维度名称:vpcId
Instances.N.Dimensions.1.Value vpcId 负载均衡所在私有网络的 ID 具体私有网络 ID,如1111
Instances.N.Dimensions.2.Name loadBalancerPort 负载均衡端口 String 类型维度名称:loadBalancerPort
Instances.N.Dimensions.2.Value loadBalancerPort 负载均衡端口 具体端口号,如80
Instances.N.Dimensions.3.Name protocol 协议 String 类型维度名称:protocol
Instances.N.Dimensions.3.Value protocol 协议 string类型,如http
Instances.N.Dimensions.4.Name lanIp 负载均衡绑定机器的 IP String 类型维度名称:lanIp
Instances.N.Dimensions.4.Value lanIp 负载均衡绑定机器的 IP 具体 IP 地址,如111.111.111.11
Instances.N.Dimensions.5.Name port 负载均衡绑定机器的端口号 String类型维度名称:port
Instances.N.Dimensions.5.Value port 负载均衡绑定机器的端口号 具体端口号,如80

2.2 指标名称

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

指标名称(metricName) 含义 单位
Connum 当前连接数
NewConn 新增连接数
Intraffic 入流量 Mbps
Outtraffic 出流量 Mbps
Inpkg 入包量 个/s
Outpkg 出包量 个/s

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 拉取单个内网负载均衡后端服务器维度的当前连接数监控数据示例

拉取某个内网负载均衡后端服务器维度某段时间内统计周期为60秒的当前连接数监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace= QCE/LB_RS_PRIVATE
&MetricName=Connum
&Period=60
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2018-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=vip
&Instances.0.Dimensions.0.Value=111.111.111.11
&Instances.0.Dimensions.1.Name=vpcId
&Instances.0.Dimensions.1.Value=123456
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-20 16:01:00",
    "EndTime": "2019-05-20 16:05:00",
    "Period": 60,
    "MetricName": "Intraffic",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "111.111.111.11"
          },
          {
            "Name": "vpcId",
            "Value": "123456"
          }
        ],
        "Timestamps": [
          1558339260,
          1558339320,
          1558339380,
          1558339440,
          1558339500
          ],
        "Values": [
          10,
          20,
          30,
          40,
          50
        ]
      }
    ],
    "RequestId": "f231ae98-7985-4009-aa48-3f9d8989347d"
  }
}

示例2

拉取多个内网负载均衡后端服务器维度某段时间内统计周期为60秒的当前连接数监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace= QCE/LB_RS_PRIVATE
&MetricName=Connum
&Period=60
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2018-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=vip
&Instances.0.Dimensions.0.Value=111.111.111.11
&Instances.0.Dimensions.1.Name=vpcId
&Instances.0.Dimensions.1.Value=123456
&Instances.1.Dimensions.0.Name=vip
&Instances.1.Dimensions.0.Value=222.222.222.22
&Instances.1.Dimensions.1.Name=vpcId
&Instances.1.Dimensions.1.Value=1234567
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-20 16:01:00",
    "EndTime": "2019-05-20 16:05:00",
    "Period": 60,
    "MetricName": "Intraffic",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "111.111.111.11"
          },
          {
            "Name": "vpcId",
            "Value": "123456"
          }
        ],
        "Timestamps": [
          1558339260,
          1558339320,
          1558339380,
          1558339440,
          1558339500
          ],
        "Values": [
          10,
          20,
          30,
          40,
          50
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "222.222.222.22"
          },
          {
            "Name": "vpcId",
            "Value": "1234567"
          }
        ],
        "Timestamps": [
          1558339260,
          1558339320,
          1558339380,
          1558339440,
          1558339500
          ],
        "Values": [
          10,
          20,
          30,
          40,
          50
        ]
      }
    ],
    "RequestId": "f231ae98-7985-4009-aa48-3f9d8989347d"
  }
}