文档中心 API 中心 云监控 各产品监控接口 黑石外网负载均衡监控接口

黑石外网负载均衡监控接口

最近更新时间:2019-06-27 20:07:34

1. 接口描述

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

获取云产品的监控数据。传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。

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

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

查询黑石外网负载均衡监控数据,入参取值如下:

黑石外网负载均衡提供了获取以下四种级别监控数据的组合: 负载均衡级别,监听器级别,监听器下服务器级别,监听器下服务器端口级别

1.1 获取负载均衡级别监控数据,入参取值如下:

&Namespace=QCE/BM_LB &Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为负载均衡的 vip

1.2 获取监听器级别监控数据,入参取值如下:

&Namespace=QCE/BM_LB &Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value为负载均衡的 vip
&Instances.N.Dimensions.1.Name=protocol
&Instances.N.Dimensions.1.Value为协议值,可取值(tcp,udp,http,https)
&Instances.N.Dimensions.2.Name=loadBalancerPort
&Instances.N.Dimensions.2.Value 为负载均衡的端口

1.3 获取监听器下服务器级别监控数据,入参取值如下:

&Namespace=QCE/BM_LB &Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为负载均衡的 vip
&Instances.N.Dimensions.1.Name=protocol
&Instances.N.Dimensions.1.Value 为协议值,可取值(tcp,udp,http,https)
&Instances.N.Dimensions.2.Name=loadBalancerPort
&Instances.N.Dimensions.2.Value 为负载均衡的端口
&Instances.N.Dimensions.3.Name=lanIp
&Instances.N.Dimensions.3.Value 为后端服务器的 IP
&Instances.N.Dimensions.4.Name=vpcId
&Instances.N.Dimensions.4.Value 为负载均衡实例所属的私有网络整形 ID,可通过 查询私有网络列表 返回的字段vpcId获得

1.4 获取监听器下服务器端口级别监控数据,入参取值如下:

&Namespace=QCE/BM_LB &Instances.N.Dimensions.0.Name=vip
&Instances.N.Dimensions.0.Value 为负载均衡的 vip
&Instances.N.Dimensions.1.Name=protocol
&Instances.N.Dimensions.1.Value 为协议值,可取值(tcp,udp,http,https)
&Instances.N.Dimensions.2.Name=loadBalancerPort
&Instances.N.Dimensions.2.Value 为负载均衡的端口
&Instances.N.Dimensions.3.Name=lanIp
&Instances.N.Dimensions.3.Value 为后端服务器的 IP
&Instances.N.Dimensions.4.Name=rsPort
&Instances.N.Dimensions.4.Value 为后端服务器的端口
&Instances.N.Dimensions.5.Name=vpcId
&Instances.N.Dimensions.5.Value为负载均衡实例所属的私有网络整形 ID,可通过 查询私有网络列表 返回的字段vpcId获得

2. 输入参数

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

2.1输入参数

2.1.1 输入参数总览

参数名称 是否必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData
Version String 公共参数,本接口取值: 2018-07-24
Region String 公共参数,表示查询的是哪个地域实例的监控数据;支持的地域可查看云服务器支持的 地域列表
Namespace String 命名空间,每个云产品会有一个命名空间,API 3.0接口版本的必须是大写,如:QCE/BM_LB
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 具体实例名称,如disk-test
Instances.N.Dimensions.1.Name protocol 为协议值 String类型维度名称:protocol
Instances.N.Dimensions.1.Value protocol 可取值(tcp,udp,http,https) 具体协议值名称,如tcp
Instances.N.Dimensions.2.Name loadBalancerPort 负载均衡的端口 String类型维度名称:loadBalancerPort
Instances.N.Dimensions.2.Value loadBalancerPort 具体的负载均衡的端口 具体实例名称,如80
Instances.N.Dimensions.3.Name lanIp 后端服务器的 IP String类型维度名称:lanIp
Instances.N.Dimensions.3.Value lanIp 具体的后端服务器的 IP 具体实例名称,如11.22.33.44
Instances.N.Dimensions.4.Name rsPort 后端服务器的端口 String类型维度名称:rsPort
Instances.N.Dimensions.4.Value rsPort 具体的后端服务器的端口 具体实例名称,如8080
Instances.N.Dimensions.5.Name vpcId 负载均衡实例所属的私有网络整形 ID String类型维度名称:vpcId
Instances.N.Dimensions.5.Value vpcId 具体的负载均衡实例所属的私有网络整形 ID 具体实例名称,如1

2.2 指标名称

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

指标名称 含义 单位
Inpkg 入包量 个/秒
Outpkg 出包量 个/秒
Intraffic 入带宽 Mbps
Outtraffic 出带宽 Mbps
Connum 当前连接数(四层监听器)
Req 请求个数(七层监听器)

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/BM_LB
&MetricName=Inpkg
&Period=60
&StartTime=2019-05-29T15:00:00+08:00
&EndTime=2019-05-29T15:05:0+08:00
&Instances.0.Dimensions.0.Name=vip
&Instances.0.Dimensions.0.Value=115.115.115.115
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-29 15:00:00",
    "EndTime": "2019-05-29 15:05:00",
    "Period": 60,
    "MetricName": "Inpkg",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "115.115.115.115"
          }
        ],
        "Timestamps": [
          1559113200,
          1559113260,
          1559113320,
          1559113380,
          1559113440,
          1559113500
        ],
        "Values": [
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    ],
    "RequestId": "f8917e88-e608-4a22-902c-f14b600ae9c7"
  }
}

示例2

拉取多个黑石外网负载均衡某段时间内统计周期为60秒的入包量监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/BM_LB
&MetricName=Inpkg
&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=115.115.115.115
&Instances.1.Dimensions.0.Name=vip
&Instances.1.Dimensions.0.Value=115.115.115.1156
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-29 15:00:00",
    "EndTime": "2019-05-29 15:05:00",
    "Period": 60,
    "MetricName": "Inpkg",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "115.115.115.115"
          }
        ],
        "Timestamps": [
          1559113200,
          1559113260,
          1559113320,
          1559113380,
          1559113440,
          1559113500
        ],
        "Values": [
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "vip",
            "Value": "115.115.115.116"
          }
        ],
        "Timestamps": [
          1559113200,
          1559113260,
          1559113320,
          1559113380,
          1559113440,
          1559113500
        ],
        "Values": [
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    ],
    "RequestId": "f8917e88-e608-4a22-902c-f14b600ae9c7"
  }
}